Simplify the docs CI pipeline #48005
Closed
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
Closes #35796 **Only run the workflow on `pull_request`**. It is not strictly necessary to run the workflow on `merge_group`, and doing so on `pull_request` simplifies the branching logic we use in the workflow. **Test the docs build using the `checkout` GitHub Actions workflow**, rather than using the name of the branch. This way, we don't need custom logic to identify the branch name. To get this to work, turn the `git-update` script in `package.json` into a no-op script. This will also make it easier to add the prose linting step to `Lint (Docs)` in the future, since we pull the `gravitational/teleport` source outside of the `yarn update-and-build` command. **Combine the Vercel preview workflow and "test the docs build" step:** Both of these run the docs build, so there is no need to separate the build step from the Vercel preview. This saves around 8-10 minutes of runner time per workflow run.
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
|
Closing since the Vercel preview workflow will soon become obsolete, so it'll be simpler to remove it. |
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.
Closes #35796
Only run the workflow on
pull_request. It is not strictly necessary to run the workflow onmerge_group, and doing so onpull_requestsimplifies the branching logic we use in the workflow.Test the docs build using the
checkoutGitHub Actions workflow, rather than using the name of the branch. This way, we don't need custom logic to identify the branch name. To get this to work, turn thegit-updatescript inpackage.jsoninto a no-op script. This will also make it easier to add the prose linting step toLint (Docs)in the future, since we pull thegravitational/teleportsource outside of theyarn update-and-buildcommand.Combine the Vercel preview workflow and "test the docs build" step: Both of these run the docs build, so there is no need to separate the build step from the Vercel preview. This saves around 8-10 minutes of runner time per workflow run.