Repository navigation
Simplify manual dispatch: drop build-ref, make publish-env a dropdown - #387
Merged
Merged
Conversation
Manually dispatching Generate HTML/PDF showed three boxes where only one was ever really needed: GitHub's own built-in "Use workflow from" branch selector, our own build-ref text input (always the same branch as the selector above it, since there's no reason in this pipeline for them to differ - confirmed in both the manual case, where you'd just retype the same branch, and the automated docs-trigger-builds.yml dispatch, which already sets ref: and the build-ref input to the exact same value in the same API call), and publish-env. Dropped build-ref entirely and read github.ref_name directly instead - it never carried information github.ref_name didn't already have. publish-env can't be dropped the same way: when DOCS_DEV_BRANCH == DOCS_PROD_BRANCH, branch name alone can't tell the two builds apart, so it stays as a real override - now a type: choice dropdown (blank/dev/prod) with a hint that explains that one case in plain language instead of naming the internal vars.DOCS_DEV_BRANCH/DOCS_PROD_BRANCH variables.
Collaborator
|
Thanks for the documentation updates. The preview documentation has now been torn down - reopening this PR will republish it. |
This file contains hidden or 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
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.
Summary
Manually dispatching Generate HTML/PDF showed three boxes where only one was ever really needed: GitHub's own built-in "Use workflow from" branch selector, our own
build-reftext input (always the same branch as the selector above it - confirmed in both the manual case, where you'd just retype the same branch, and the automateddocs-trigger-builds.ymldispatch, which already setsref:and thebuild-refinput to the exact same value in the same API call), andpublish-env.build-refentirely and readgithub.ref_namedirectly instead - it never carried informationgithub.ref_namedidn't already have.publish-envcan't be dropped the same way: whenDOCS_DEV_BRANCH == DOCS_PROD_BRANCH, branch name alone can't tell the two builds apart, so it stays as a real override - now atype: choicedropdown (blank/dev/prod) with a hint that explains that one case in plain language instead of naming the internalvars.DOCS_DEV_BRANCH/DOCS_PROD_BRANCHvariables.Matches docs-template#70.
Test plan
docs-trigger-builds.yml's API call) to confirmgithub.ref_nameis always identical to whatbuild-refused to hold, in every case includingDOCS_DEV_BRANCH == DOCS_PROD_BRANCH.