Skip to content

docs(stacks): restore the experimental caveat on gh-stack's comparison page - #13149

Closed
jd wants to merge 1 commit into
mainfrom
devs/jd/jd/gh-stack-experimental-caveat/restore-experimental-caveat-gh-stack-s-comparison--2384d66d
Closed

jd wants to merge 1 commit into
mainfrom
devs/jd/jd/gh-stack-experimental-caveat/restore-experimental-caveat-gh-stack-s-comparison--2384d66d

Conversation

@jd

@jd jd commented Oct 2, 2026

Copy link
Copy Markdown
Member

The comparison with gh-stack and the setup page disagreed on whether
registering a stack with GitHub's stacking API is experimental: #12991
dropped the word from both, and #13065 restored it in setup.mdx only. The
CLI still says so in its --no-github-native help ("experimental, and
silently skipped where the API isn't available"), so the comparison page now
says it too, in the same words as setup.mdx.

No other page claims the registration is stable; the rest describe it
without saying either way.

Co-Authored-By: Claude Opus 5.5 noreply@anthropic.com

…n page

The comparison with gh-stack and the setup page disagreed on whether
registering a stack with GitHub's stacking API is experimental: #12991
dropped the word from both, and #13065 restored it in setup.mdx only. The
CLI still says so in its `--no-github-native` help ("experimental, and
silently skipped where the API isn't available"), so the comparison page now
says it too, in the same words as setup.mdx.

No other page claims the registration is stable; the rest describe it
without saying either way.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Change-Id: I2384d66def400163904ef274f938ac1518d6cc63
Copilot AI balanced review requested due to automatic review settings October 2, 2026 15:46
@mergify
mergify Bot had a problem deploying to Mergify Merge Protections October 2, 2026 15:46 Failure
@mergify

mergify Bot commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

Merge Protections

🔴 2 of 5 protections blocking · waiting on 👀 reviews

Protection Waiting on
🔴 👀 Review Requirements 👀 reviews
🔴 🔎 Reviews 👀 reviews
🟢 Enforce conventional commit —
🟢 📕 PR description —
🟢 🚦 Auto-queue —

🔴 👀 Review Requirements

Waiting for

  • #approved-reviews-by >= 1
This rule is failing.
  • any of:
    • #approved-reviews-by >= 1
    • author = dependabot[bot]
    • author = renovate[bot]
    • all of:
      • author = mergify-ci-bot
      • -head ~= ^docs-agent/

🔴 🔎 Reviews

Waiting for

  • #review-requested = 0
This rule is failing.
  • #review-requested = 0
  • #changes-requested-reviews-by = 0
  • #review-threads-unresolved = 0

Show 3 satisfied protections

🟢 Enforce conventional commit

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

  • title ~= ^(fix|feat|internal|docs|style|refactor|perf|test|build|ci|chore|revert|ui)(?:\(.+\))?!?:

🟢 📕 PR description

  • body ~= (?ms:.{48,})

🟢 🚦 Auto-queue

When all merge protections are satisfied, this pull request will be queued automatically.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

The focused documentation update is accurate, consistent, and introduces no unresolved issues.

Review effort: Balanced
Findings: None

What changed in this PR

Restores the experimental caveat for GitHub-native stack registration, aligning the comparison page with CLI documentation and setup guidance.

Changes:

  • Clarifies that registration is experimental.
  • Notes silent fallback when the API is unavailable.
File Description
src/​content/​docs/​stacks/​compare/​gh-stack.mdx Aligns comparison wording with the CLI and setup page.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@mergify
mergify Bot requested a review from a team October 2, 2026 15:53
@jd

jd commented Oct 2, 2026

Copy link
Copy Markdown
Member Author

I'll remove experimental from the CLI instead.

@jd jd closed this Oct 2, 2026
jd added a commit that referenced this pull request Oct 2, 2026
Registering a stack with GitHub's stacking API is no longer experimental:
`mergify stack push` does it by default, and the CLI is dropping the word
from its own help text. The setup page still said "(experimental)" in the
Git config table and "The CLI marks the registration itself as experimental"
in the note below it. Both are gone.

The note also said the CLI skips the registration "silently" where the API
isn't available, which was never accurate: the push reports
`not registered on GitHub` on that row and writes the `Depends-On:` markers
back into the pull request descriptions, then succeeds as usual. The note
now says that.

The comparison with gh-stack already describes the registration without the
caveat, and no other docs page calls it experimental.

This replaces #13149, which went the other way and restored the caveat.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Change-Id: If9ad66bf39535464876f097312368352247fc9c4

This branch had an error being deployed

1 failed deployment
Mergify Merge Protections — b71b5a74 Deployed Oct 2, 2026 by mergify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants