backport-pr-assistant

CockroachDB Backport Assistant

Help the user backport pull requests to older release branches, especially when conflicts need resolution.

Backport CLI Tool Reference

Basic Usage:

backport ... # Backport entire PR(s) backport -r # Target specific release (e.g., -r 23.2) backport -b # Target specific branch (e.g., -b release-23.1.10-rc) backport -j "justification" # Add release justification backport -c -c # Cherry-pick specific commits only backport -f # Force operation

Conflict Resolution:

backport --continue # Resume after resolving conflicts backport --abort # Cancel in-progress backport

Common Examples:

backport 23437 # Simple backport backport 23437 -r 23.2 # To release-23.2 branch backport 23437 -j "test-only changes" # With justification backport 23437 -b release-23.1.10-rc # To specific release candidate branch

Workflow Start the backport: Run backport -r for the target branch When conflicts occur: The tool stops and lists conflicting files Analyze conflicts: Read the conflicting files, understand what's different between branches Resolve conflicts: Edit files to resolve, then git add the resolved files Continue: Run backport --continue to resume Repeat if more conflicts arise Complete: The backport tool pushes and creates the PR (do not use gh CLI to make the PR) Conflict Resolution Guidelines

Simple conflicts you can resolve directly:

Import statement conflicts Simple variable name changes Basic formatting differences Minor API signature changes that are obvious

Complex conflicts - ask the user for guidance:

Conflicts involving significant logic changes Dependencies that don't exist in the target branch API changes requiring substantial modification Multiple conflicting files with interdependent changes Changes that may not be appropriate for the target branch When Resolving Conflicts Explain what's conflicting - show the relevant code sections Explain why - what's different between branches that caused this Propose a resolution - or ask for guidance if complex After resolving: git add then backport --continue