docs on rebase workflow#93
Open
skarim wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new “Rebasing Your Stack” section to the workflows guide to help users understand the cascading rebase workflow in gh-stack, including CLI vs. GitHub UI behavior and conflict-resolution steps.
Changes:
- Documented how
gh stack rebasecascades through a stack, including--downstack/--upstack. - Added guidance on the rebase → push (safe force-push) cycle, including
gh stack syncas a shortcut. - Added a CLI vs. web UI comparison and a step-by-step conflict resolution walkthrough.
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/guides/workflows.md | Adds a comprehensive “Rebasing Your Stack” section covering cascade behavior, conflict handling, and CLI vs. UI differences. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 1
skarim
force-pushed
the
skarim/init-revamp
branch
from
c85384a to
6692218
Compare
skarim
force-pushed
the
skarim/rebase-docs
branch
2 times, most recently
from
d03e627 to
5230ee3
Compare
skarim
force-pushed
the
skarim/init-revamp
branch
from
6692218 to
3854aa2
Compare
skarim
force-pushed
the
skarim/rebase-docs
branch
from
5230ee3 to
34f345d
Compare
skarim
force-pushed
the
skarim/rebase-docs
branch
from
34f345d to
5a21a27
Compare
skarim
force-pushed
the
skarim/init-revamp
branch
from
d1f6674 to
6f6a077
Compare
ktravers
approved these changes
May 15, 2026
| gh stack push | ||
| ``` | ||
|
|
||
| `gh stack push` uses `--force-with-lease` to safely update the rebased branches. This is a safe form of force push — it ensures you don't overwrite changes that someone else pushed since your last fetch. If the remote has unexpected changes, the push is rejected and you can investigate. |
There was a problem hiding this comment.
This is an especially helpful detail, glad this is in here ✨
| | **Commit signing** | Commits are signed with your local Git committer config (GPG/SSH signing, if configured) | Commits retain the original author but the committer is set to whoever clicked the button — commits are **not** signed | | ||
| | **Conflict resolution** | Interactive — you resolve conflicts in your editor, then `gh stack rebase --continue` | Not available if there are conflicts — you must rebase locally | | ||
|
|
||
| If commit signing matters for your project (e.g., branch protection rules require signed commits), use the CLI for rebases. |
There was a problem hiding this comment.
Wondering if we should emphasize this more:
Suggested change
| If commit signing matters for your project (e.g., branch protection rules require signed commits), use the CLI for rebases. | |
| > [!IMPORTANT] | |
| > If commit signing matters for your project (e.g., branch protection rules require signed commits), use the CLI for rebases. |
We've seen people be surprised by this, so could be helpful to boost a bit and maybe head off some complaints.
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.
Add rebase workflow guide
Add a comprehensive "Rebasing Your Stack" section to the workflows guide covering the rebase lifecycle, conflict resolution, and CLI vs. web UI differences.
Changes
docs/src/content/docs/guides/workflows.md): New section covering:--downstack,--upstack)--continue/--abort)Stack created with GitHub Stacks CLI • Give Feedback 💬