feat: add workflow_dispatch to docs #6235
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
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## unstable #6235 +/- ##
=========================================
Coverage 80.83% 80.83%
=========================================
Files 185 185
Lines 17986 17986
Branches 1082 1082
=========================================
Hits 14539 14539
Misses 3421 3421
Partials 26 26 |
Performance Report✔️ no performance regression detected Full benchmark results
|
wemeetagain
reviewed
Dec 27, 2023
|
|
||
| jobs: | ||
| docs: | ||
| runs-on: buildjet-4vcpu-ubuntu-2204 | ||
| env: | ||
| DEPLOY_REF: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.ref || 'stable' }} |
There was a problem hiding this comment.
A little strange that the default here is 'stable' but above, its 'unstable'. I'd say pick one or the other
There was a problem hiding this comment.
That was so that its deploying stable if running push and defaulting to unstable in the manual deploy option with workflow_dispatch.
I wanted to maintain the original behavior of docs deploying when merged to stable and assumed we would most likely be manually deploying from unstable after a docs PR but between releases that auto deploy.
Do you want me to convert the hardcoded branch to || github.ref }} so that it will be more clear that its the value that push triggered the workflow?
The actions/checkout defaults the ref value to github.ref (or default branch if no github.ref is available) when one is not provided in the template.
There was a problem hiding this comment.
Oh I see, that makes sense! Looks good as is
wemeetagain
approved these changes
Dec 27, 2023
|
🎉 This PR is included in v1.14.0 🎉 |
ensi321
pushed a commit
to ensi321/lodestar
that referenced
this pull request
Jan 22, 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.
Motivation
Adds a button to the docs workflow to manually deploy the docs website from any branch. The workflow will still run on pushes to stable but it also can now be run to deploy a different branch of the docs. Any
branch,tag, orcommitwill work and the workflow will validate that its a validaterefbefore running the deploy process. The default was set asunstableas I assumed we would want to PR the docs updates before deploying them but any branch will work.Note: The workflow will still run on
stableautomatically to keep the docs in sync with our releases as they are released. We will need to be cognizant of this if there are changes to the docs that need to get merged with releases as we normally do so should not be a big hurdle but I wanted to make sure that is noted here.Note: There is a default dropdown provided for "workflow_dispatch" events and the dropdown will specify the version of the workflow that is being run. The second input field is the one that we want to use at deploy time. It will select the
reffor the docs that will be deployed.Testing
Was developed with a bit of help from chatgpt to verify that the syntax was correct but we may need to run once to triple check there are no bugs.