ci(docs): publish the internal preview from the internal-preview branch - #214
Merged
Merged
Conversation
docs-v2 will be merged into dev and deleted. The internal preview therefore moves to a branch that exists only to publish it, and feature pull requests target that branch. A merge into internal-preview now publishes the site, so pull requests into it run the test-deploy build first. The public GitHub Pages job does not change. Merge this into docs-v2 before internal-preview is created. The new branch then starts with this workflow, and docs-v2 stops the deploy at once. Refs PRODUCT-209 Co-Authored-By: Claude Code - Claude Opus 5 <noreply@anthropic.com>
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
1 participant
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.
Jira: PRODUCT-209 · Infra: handpoint/handpoint-scripts#906 (commit
8358628a2)Why
docs-v2will be merged intodevand deleted. The internal preview at https://developers-internal.handpoint.io therefore moves to a new branch,internal-preview, that exists only to publish it. Feature pull requests targetinternal-preview.What changes
.github/workflows/deploy.ymlpushandpull_requestlistinternal-previewinstead ofdocs-v2. Thedeploy-stagingjob runs onrefs/heads/internal-preview. The concurrency group is renamedREADME.mdinternal-preview. The stack path is corrected toaws/documentation/infra/docs-internal/README.mdinternal-previewas the branch that holds the folderdocs/reference/known-issues.mdxdata/knownIssues.jspoints tointernal-preview. Thedocs-v2link breaks when that branch is deletedThe GitHub Pages
deployjob does not change.New: pull requests into
internal-previewrun thetest-deploybuild. A merge into that branch publishes the site, so a broken build must fail on the pull request.Do not merge this pull request before the infra plan is reviewed. The cutover order is:
docs-v2.docs-v2stops the deploy at once, because a push reads the workflow from the pushed commit.-target=aws_iam_role.internal_documentation_deploy. The role then trustsinternal-previewonly.internal-previewfrom thedocs-v2HEAD. Its first push publishes the site.internal-preview.Verification
yarn test: 30 passed, 4 failed. The same 4 tests ingenerate-acquirer-pages.test.jsfail onorigin/docs-v2without this change.yarn generate && yarn buildsucceeds. The built known-issues page links toblob/internal-preview/data/knownIssues.js.deploy.ifis unchanged, anddeploy-staging.ifcompares withrefs/heads/internal-preview.git grep docs-v2finds onlyscripts/deploy-staging.sh:50and its test. That text names a stack path, not a branch. It is outside this change.🤖 Generated with Claude Code