Skip to content

docs on rebase workflow#93

Merged
skarim merged 2 commits into
skarim/init-revampfrom
skarim/rebase-docs
May 15, 2026
Merged

docs on rebase workflow#93
skarim merged 2 commits into
skarim/init-revampfrom
skarim/rebase-docs

Conversation

@skarim
Copy link
Copy Markdown
Collaborator

@skarim skarim commented May 14, 2026

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

  • Workflows guide (docs/src/content/docs/guides/workflows.md): New section covering:
    • How cascading rebase works (--downstack, --upstack)
    • CLI vs. web UI comparison table (commit signing, conflict resolution, cascading behavior)
    • Step-by-step conflict resolution (--continue / --abort)
    • The rebase + force-push cycle for users coming from merge-commit workflows

Stack created with GitHub Stacks CLIGive Feedback 💬

@skarim skarim marked this pull request as ready for review May 14, 2026 22:16
Copilot AI review requested due to automatic review settings May 14, 2026 22:16
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 rebase cascades through a stack, including --downstack / --upstack.
  • Added guidance on the rebase → push (safe force-push) cycle, including gh stack sync as 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

Comment thread docs/src/content/docs/guides/workflows.md
@skarim skarim force-pushed the skarim/init-revamp branch from c85384a to 6692218 Compare May 14, 2026 22:24
@skarim skarim force-pushed the skarim/rebase-docs branch 2 times, most recently from d03e627 to 5230ee3 Compare May 14, 2026 22:24
@skarim skarim force-pushed the skarim/init-revamp branch from 6692218 to 3854aa2 Compare May 14, 2026 22:24
@skarim skarim force-pushed the skarim/rebase-docs branch 2 times, most recently from 34f345d to 5a21a27 Compare May 14, 2026 22:55
@skarim skarim force-pushed the skarim/init-revamp branch from d1f6674 to 6f6a077 Compare May 14, 2026 22:55
Copy link
Copy Markdown

@ktravers ktravers left a comment

Choose a reason for hiding this comment

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

Some very helpful additions!

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.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This is an especially helpful detail, glad this is in here ✨

Comment thread docs/src/content/docs/guides/workflows.md
@skarim skarim force-pushed the skarim/rebase-docs branch from 5a21a27 to 4b6bdda Compare May 15, 2026 14:18
@skarim skarim force-pushed the skarim/init-revamp branch from 6f6a077 to 0706796 Compare May 15, 2026 14:18
@skarim skarim merged commit 650a946 into main May 15, 2026
6 checks passed
@skarim skarim deleted the skarim/rebase-docs branch May 15, 2026 18:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants