docs: stack object in pull_request webhooks#67
Merged
Conversation
…hook events Agent-Logs-Url: https://github.com/github/gh-stack/sessions/cf10db22-af0b-45c3-95d6-de9ef313d624 Co-authored-by: willsmythe <2503052+willsmythe@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update docs with stack details in pull request webhook event
docs: Add CI/webhook integration guide for stack PRs
Apr 24, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for the pull_request.stack object surfaced in pull_request webhook payloads and links it from the docs sidebar, plus an FAQ entry showing how to access this data in GitHub Actions workflows.
Changes:
- Adds a new Webhooks reference page documenting the
pull_request.stack.base.{ref,sha}fields. - Extends the FAQ with a GitHub Actions snippet and a small reference table for
github.event.pull_request.stack. - Updates the docs sidebar to include the new Webhooks reference page.
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/reference/webhooks.md | New reference page explaining the stack object in pull_request webhook payloads and how it relates to Actions. |
| docs/src/content/docs/faq.md | Adds an FAQ section showing how to read pull_request.stack in GitHub Actions expressions. |
| docs/astro.config.mjs | Adds “Webhooks” to the Reference sidebar. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comments suppressed due to low confidence (1)
docs/src/content/docs/reference/webhooks.md:45
- This is internally inconsistent: it says the
stackobject is only present when the PR belongs to a stack, but then says for standalone PRs the field isnull. For JSON webhook payloads, either document that the property is omitted/absent for standalone PRs, or (if it really is present) show it explicitly as"stack": nullin the example payload.
The `stack` object is **only present** when the pull request belongs to a stack. For standalone PRs, the field is null.
- Files reviewed: 3/3 changed files
- Comments generated: 3
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
skarim
approved these changes
May 4, 2026
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.
pull_requestwebhook events now include astackobject for PRs that belong to a stack. Without documentation, teams can't easily discover how to usestack.base.refto trigger CI on every PR in a stack targetingmain— not just the bottom PR that directly targetsmain.Changes
New guide
docs/src/content/docs/guides/ci-integration.md:stackobject shape inpull_requestwebhook payloadspull_request.base.ref(direct PR base) frompull_request.stack.base.ref(ultimate stack target)ifcondition example covering both stacked and standalone PRsstack.base.sha(drift detection, targetedgit log, CI caching)docs/astro.config.mjs: Adds the new guide to the sidebar under Guides.Key pattern documented