docs: document pre-PR-open branch rebase [doc-updater] - #2303
Merged
Conversation
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).
This comment has been minimized.
This comment has been minimized.
Contributor
There was a problem hiding this comment.
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 beforespawner.gateway.create_pr(...)at line 7651 — the bullet's "Immediately before callinggh 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
Falseand restoresorigin/<branch>on every failure path),base_branchis read-only (no push to base ever, only topipeline_branch), and the PR still opens against the un-rebased tip on failure (the outertry/exceptat 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
Contributor
Author
|
egg review completed. View run logs 1 previous review(s) hidden. |
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.
docs: document pre-PR-open branch rebase in PR phase
Update
docs/guides/sdlc-pipeline.mdto reflect the new best-effort rebasestep added by d9c416f (#2291, part of #2224 PR 2/3).
The orchestrator now rebases the pipeline branch against current
origin/<base_branch>immediately before callinggh pr create, closingthe gap where
base_branchadvances during the PR phase. The existing PRphase 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