Update breaking changes from starter-pack and improve workflow #220
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
agileshaw
force-pushed
the
starter-pack-update
branch
from
68baf05
to
bc7d3a3
Compare
agileshaw
force-pushed
the
starter-pack-update
branch
from
bc7d3a3
to
3130e9b
Compare
- There are recent breaking changes in canonical/sphinx-docs-starter-pack that causes our workflow to fail. Updated those changes in COU to align. - Update the workflow to only trigger documentation checks if a PR modifies `docs/`. This will prevent un-necessary runs. I'm keeping the on.push as is because I think it is good to have a way to notify us about dependency breakage (those issues are not affecting live doc site).
agileshaw
force-pushed
the
starter-pack-update
branch
from
3130e9b
to
201e713
Compare
There was a problem hiding this comment.
Generally, LGTM. I'm wondering if it would be good or possible to have in our Makefile a option to sync with the upstream documentation as it happens for example on charm-helpers on classic charms.
|
@gabrielcocenza Right now there's no clean way to automate the upstream tracking because we are modifying the files from starter-pack. Documentation team is aware of the limitation and will work on supporting such an automation. But until then, there's nothing we can do from our side. |
gabrielcocenza
approved these changes
Jan 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
docs/. This will prevent un-necessary runs. I'm keeping the on.push as is because I think it is good to have a way to notify us about dependency breakage (those issues are not affecting live doc site).