Skip to content

docs: document pre-PR-open branch rebase [doc-updater] - #2303

Merged
jwbron merged 1 commit into
mainfrom
egg/doc-update-pr-open-rebase
Apr 29, 2026
Merged

docs: document pre-PR-open branch rebase [doc-updater]#2303
jwbron merged 1 commit into
mainfrom
egg/doc-update-pr-open-rebase

Conversation

@james-in-a-box

Copy link
Copy Markdown
Contributor

docs: document pre-PR-open branch rebase in PR phase

Update docs/guides/sdlc-pipeline.md to reflect the new best-effort rebase
step added by d9c416f (#2291, part of #2224 PR 2/3).

The orchestrator now rebases the pipeline branch against current
origin/<base_branch> immediately before calling gh pr create, closing
the gap where base_branch advances during the PR phase. The existing PR
phase section already lists the other pre-PR-open steps (agent-outputs
cleanup, BRC history safety net, draft preservation); this adds a matching
bullet for the new rebase step.

Triggered by: d9c416f (Part of #2224 (2/3): rebase pipeline branch against current base_branch before PR open)

Authored-by: egg

Add a bullet to the PR-phase section of docs/guides/sdlc-pipeline.md
describing the new best-effort rebase step introduced by #2224 (PR 2/3).

@egg-reviewer egg-reviewer Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No agent-mode design concerns. This is a documentation-only change adding a single bullet describing an orchestrator infrastructure step (pre-PR-open rebase). No agent prompts, LLM call paths, or workflow design are touched.

— Authored by egg

@james-in-a-box

This comment has been minimized.

@egg-reviewer egg-reviewer Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Verified the doc bullet against the implementation in orchestrator/routes/pipelines.py:

  • The helper _refresh_pipeline_branch_against_current_base() (line 5760) is invoked at line 7633, immediately before spawner.gateway.create_pr(...) at line 7651 — the bullet's "Immediately before calling gh pr create" is accurate.
  • _rebase_pipeline_branch_onto_base (line 5446) is correctly characterized as a phase-start helper; the in-code comment at line 7623–7625 uses the same framing the bullet adopts.
  • The helper's docstring (5778–5798) and the seven-step body confirm every claim in the bullet: best-effort (returns False and restores origin/<branch> on every failure path), base_branch is read-only (no push to base ever, only to pipeline_branch), and the PR still opens against the un-rebased tip on failure (the outer try/except at 7641–7648 also catches a hypothetical helper bug so PR creation is never blocked).
  • Bullet placement matches execution order: BRC history safety net → pre-PR-open rebase → gh pr create → draft preservation note (which is descriptive, not an action). Style and tone match the existing bullets in the section.

No blocking issues.

— Authored by egg

@james-in-a-box

Copy link
Copy Markdown
Contributor Author

egg review completed. View run logs

1 previous review(s) hidden.

@jwbron
jwbron merged commit 004666d into main Apr 29, 2026
29 checks passed
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.

1 participant