Conversation
Each push to main that changes more than Markdown runs scripts/open-docs-pr.sh, which pushes a docs/<sha> branch with one empty commit and opens a draft PR linking the source PR and listing the files it changed. Closes #1105. Signed-off-by: dhruv8sh <dhruv8sh@proton.me>
This branch has not been deployed
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
main, open a draft documentation PR so the doc updates for that change have a home and don't get forgotten.docs/<sha>) with one empty commit, links the source PR, and lists the files the merge changed.docs/**or Markdown are skipped.Changes
.github/workflows/docs-pr.ymlmain(ignoring docs/Markdown-only pushes); job-scopedcontents: writeandpull-requests: write.scripts/open-docs-pr.shdocs/<sha>branch, pushes it, and opens the draft PR withgh. Falls back to the commit's own diff when the push's before-SHA is all zeros. Caps the file list at 100.DRY_RUN=1prints the PR instead.scripts/README.mdCloses
Closes #1105
Test plan
cargo test-fastly && cargo test-axum(pluscargo test-cloudflare)cargo clippy-fastly && cargo clippy-axum(pluscargo clippy-cloudflare,cargo check-cloudflare)cargo fmt --all -- --checkcd crates/trusted-server-js/lib && npx vitest run(on the pinned Node 24.12.0)cd crates/trusted-server-js/lib && npm run formatcd docs && npm run formatcargo build --package trusted-server-adapter-fastly --release --target wasm32-wasip1fastly compute serveactionlinton the workflow andshellcheckon the script: clean.DRY_RUN=1against Make body hold parser-aware and stream Next.js processing #1135's merge commit: correct title, source PR resolved to Make body hold parser-aware and stream Next.js processing #1135, all 29 changed files listed; the all-zero before-SHA fallback produces the same result.gh: the branch has exactly one empty commit on the merge commit, andgh pr create --draft --base mainreceives the expected title and body.Notes for reviewers
gh pr createto succeed.GITHUB_TOKENdo not trigger other workflows, so CI will not run on these draft PRs until someone pushes to them. Swapping in a GitHub App token would change that if CI on open is wanted.Checklist
unwrap()in production code — useexpect("should ...")(no Rust changes)tracingmacros (notprintln!) (no Rust changes)