ci/docs: Run on tagged releases only #1009
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
This changes the ci/docs workflow to only run on tagged releases by default instead of every push to main. This also updates the existing workflow_dispatch trigger to expect an input specifying the ref to publish docs from. With that, you should be able to specify a branch or tag from the Actions UI. Going this route has the disadvantage that all documentation fixes and updates after a release will not be available on the website until another release or a manual publish which can accidentally also publish documentation for unreleased features. Refs #1008
abhinav
commented
Jan 2, 2023
Comment on lines
+36
to
+42
| if: github.event_name != 'workflow_dispatch' | ||
| uses: actions/checkout@v3 | ||
| - name: Checkout (manual) | ||
| if: github.event_name == 'workflow_dispatch' | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| ref: ${{ inputs.head }} |
There was a problem hiding this comment.
I believe you can collapse these into one and do:
ref: ${{ inputs.head || github.ref }}
But I'm not certain about it, so I opted for the duplicated version for now.
Codecov Report
@@ Coverage Diff @@
## master #1009 +/- ##
=======================================
Coverage 98.14% 98.14%
=======================================
Files 39 39
Lines 1994 1994
=======================================
Hits 1957 1957
Misses 29 29
Partials 8 8 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
sywhang
approved these changes
Jan 2, 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.
This changes the ci/docs workflow
to only run on tagged releases by default
instead of every push to main.
This also updates the existing workflow_dispatch trigger to expect an input specifying the ref to publish docs from. With that, you should be able to specify a branch or tag from the Actions UI.
Example of how this looks from one of my projects:
Going this route has the disadvantage that
all documentation fixes and updates after a release will not be available on the website until another release or a manual publish which can accidentally also publish documentation for unreleased features.
Refs #1008