ci: migrate website deploy to first-party GitHub Pages actions#268
Merged
Conversation
Replace the third-party peaceiris/actions-gh-pages publish step with GitHub's first-party Pages actions (configure-pages, upload-pages-artifact, deploy-pages) in a two-job build/deploy workflow. Drop contents: write in favor of the least-privilege OIDC model (contents: read, pages: write, id-token: write) and add a pages concurrency group with cancel-in-progress: false. Remove the now-unused deploymentBranch from docusaurus.config.js, and update website/README.md plus the git-workflow and ci-workflows steering docs to describe the artifact-based deploy (no gh-pages branch push). Requires a one-time repo setting change: Settings -> Pages -> Build and deployment -> Source = "GitHub Actions". Refs: .kiro/specs/github-pages-firstparty-deploy
Dependency ReviewThe following issues were found:
License Issues.github/workflows/website-deploy.yaml
OpenSSF Scorecard
Scanned Files
|
|
Scan for commit: 🔒 Security Scan ResultsScanned files: 5 |
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
2 participants
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.
Replace the third-party peaceiris/actions-gh-pages publish step with GitHub's first-party Pages actions (configure-pages, upload-pages-artifact, deploy-pages) in a two-job build/deploy workflow. Drop contents: write in favor of the least-privilege OIDC model (contents: read, pages: write, id-token: write) and add a pages concurrency group with cancel-in-progress: false.
Remove the now-unused deploymentBranch from docusaurus.config.js, and update website/README.md plus the git-workflow and ci-workflows steering docs to describe the artifact-based deploy (no gh-pages branch push).
Requires a one-time repo setting change: Settings -> Pages -> Build and deployment -> Source = "GitHub Actions".
Refs: .kiro/specs/github-pages-firstparty-deploy
What does this PR do?
🛑 Please open an issue first to discuss any significant work and flesh out details/direction — we would hate for your time to be wasted.
Consult the CONTRIBUTING guide for submitting pull-requests.
Motivation
Type of Change
Testing
npm run buildsuccessfullynpm run testand all tests passnpx cdk synthwith a sample.env(e.g. fromblueprints/dummy/samples/) and it succeedsnpm run run-pre-commitNew Blueprint Checklist (if adding a protocol)
blueprints/dummy/(reference implementation).envfiles are provided for at least one network (mainnet or testnet)blueprints/dummy/)website/docs/blueprints/(.mdx mirror importing README)Documentation
cd website && npm run buildwith no broken links (if docs changed)License
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.