fix: docs deployment action #1869
Merged
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
Signed-off-by: Nikolay Ulmasov <ulmasov@hotmail.com>
wjones127
approved these changes
Nov 17, 2023
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.
Description
Moved the requirement for contents write permission from release action to docs deployment. The same permission was used in the previous release action (sphinx) so I'm not introducing any extra permission requirements.
One thing I don't really like here is that such permission is only needed for the
Deploystep but the lowest level it can be defined is job. This should be fine because other steps in the job don't do any git operations.Alternative would be creating a separate Deploy job but then I'd have to duplicate all the steps from the Build part which would effectively be the same thing as now but with a longer/redundant config.
Deployment logic remains the same - docs are deployed only when the Build Documentation is run manually or via the Release Python action.
Related Issue(s)
#1867
I am unable to fully test this in my environment because the failing version was actually working in my repo - I don't see how things are configured in the main repo.