Add manual intervention guide to README#8
Add manual intervention guide to README#8kaovilai wants to merge 1 commit intooadp-rebasebot:oadp-devfrom
Conversation
Document the workflow for resolving rebasebot failures when --conflict-policy strict detects upstream content loss during cherry-picking of old merge commits. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for manual intervention when the rebasebot encounters conflicts during cherry-picking operations. The guide explains how to recover from situations where --conflict-policy strict detects upstream content loss, typically caused by old merge commits being cherry-picked with -Xtheirs strategy.
Changes:
- Added "Manual Intervention Guide" section documenting the workflow for resolving rebasebot failures
- Documented the
.rebase/working directory structure with three configured remotes (source, dest, rebase) - Provided step-by-step recovery instructions including how to run hook scripts manually from local checkout
- Used generalized placeholders (
<upstream-branch>,<branch>,<repo>) making the guide applicable to any repository
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@kaovilai should we wait with this until openshift-eng/rebasebot#78 is merged ? |
|
sure |
|
@coderabbitai full review |
✅ Actions performedFull review triggered. |
📝 WalkthroughWalkthroughAdded a "Manual Intervention Guide" section to README.md that explains how rebasebot behaves when Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 170-172: The fenced code block containing the line "ERROR - Manual
intervention is needed to rebase <source> into <dest>" is missing a language
tag; update that triple-backtick fence in README.md to include a language
identifier (for example `text` or `bash`) so the block becomes ```text (or
```bash) to satisfy MD040 and remove the markdownlint warning.
- Around line 228-231: The two consecutive blockquote paragraphs starting with
"**Note:** Check the corresponding config..." and "**Note:** After pushing, you
can create a PR..." contain an extra blank line between them which triggers
markdownlint MD028; remove the blank line so the blockquote is contiguous (or
alternatively convert them into two separate blockquote blocks explicitly),
ensuring the two "**Note:**" lines are directly adjacent to satisfy MD028 for
the README content.
| ``` | ||
| ERROR - Manual intervention is needed to rebase <source> into <dest> | ||
| ``` |
There was a problem hiding this comment.
Add a language to the fenced code block.
Markdownlint flags the code fence as missing a language. Specify a language (e.g., text or bash) to satisfy MD040.
✅ Suggested fix
-```
+```text
ERROR - Manual intervention is needed to rebase <source> into <dest></details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 170-170: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 170 - 172, The fenced code block containing the line
"ERROR - Manual intervention is needed to rebase <source> into <dest>" is
missing a language tag; update that triple-backtick fence in README.md to
include a language identifier (for example `text` or `bash`) so the block
becomes ```text (or ```bash) to satisfy MD040 and remove the markdownlint
warning.
| > **Note:** Check the corresponding config in `rebase-configs/` (e.g., `openshift_velero_plugin_for_gcp_oadp-dev.env.sh`) to see which hook scripts are required for each repository and branch. | ||
|
|
||
| > **Note:** After pushing, you can create a PR manually from the rebase fork to the downstream repo, or re-run rebasebot — it will detect the existing branch and create/update the PR automatically. | ||
|
|
There was a problem hiding this comment.
Remove blank lines inside the blockquote.
Markdownlint reports blank lines inside the blockquote (MD028). Keep the blockquote contiguous or split it into separate blockquotes.
✅ Suggested fix
-> **Note:** Check the corresponding config in `rebase-configs/` (e.g., `openshift_velero_plugin_for_gcp_oadp-dev.env.sh`) to see which hook scripts are required for each repository and branch.
-
-> **Note:** After pushing, you can create a PR manually from the rebase fork to the downstream repo, or re-run rebasebot — it will detect the existing branch and create/update the PR automatically.
+> **Note:** Check the corresponding config in `rebase-configs/` (e.g., `openshift_velero_plugin_for_gcp_oadp-dev.env.sh`) to see which hook scripts are required for each repository and branch.
+> **Note:** After pushing, you can create a PR manually from the rebase fork to the downstream repo, or re-run rebasebot — it will detect the existing branch and create/update the PR automatically.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| > **Note:** Check the corresponding config in `rebase-configs/` (e.g., `openshift_velero_plugin_for_gcp_oadp-dev.env.sh`) to see which hook scripts are required for each repository and branch. | |
| > **Note:** After pushing, you can create a PR manually from the rebase fork to the downstream repo, or re-run rebasebot — it will detect the existing branch and create/update the PR automatically. | |
| > **Note:** Check the corresponding config in `rebase-configs/` (e.g., `openshift_velero_plugin_for_gcp_oadp-dev.env.sh`) to see which hook scripts are required for each repository and branch. | |
| > **Note:** After pushing, you can create a PR manually from the rebase fork to the downstream repo, or re-run rebasebot — it will detect the existing branch and create/update the PR automatically. |
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 229-229: Blank line inside blockquote
(MD028, no-blanks-blockquote)
[warning] 231-231: Blank line inside blockquote
(MD028, no-blanks-blockquote)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 228 - 231, The two consecutive blockquote paragraphs
starting with "**Note:** Check the corresponding config..." and "**Note:** After
pushing, you can create a PR..." contain an extra blank line between them which
triggers markdownlint MD028; remove the blank line so the blockquote is
contiguous (or alternatively convert them into two separate blockquote blocks
explicitly), ensuring the two "**Note:**" lines are directly adjacent to satisfy
MD028 for the README content.
Summary
--conflict-policy strictdetects upstream content loss during cherry-picking of old merge commitsrebasebot-hook-scripts/rather than curling from GitHubTest plan
velero-plugin-for-gcp.rebase/working directoryNote
Responses generated with Claude
Summary by CodeRabbit