gmgauthier/grokkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 10 Wiki Activity

Add --base Flag to prdescribe Command for Custom Base Branch Comparison #3

Merged
gmgauthier merged 1 commits from fix/add_base_branch_to_prdescribe into master 2026-03-04 18:16:54 +00:00
Conversation 0 Commits 1 Files Changed 2 +60 -13
gmgauthier commented 2026-03-04 18:14:41 +00:00
Owner
Copy Link

Description

This PR introduces a new --base (or -b) flag to the prdescribe command, allowing users to specify a custom base branch for generating Git diffs (e.g., comparing against develop instead of the default master). This enhances flexibility for repositories with non-standard branching strategies. The default remains master for backward compatibility.

If the initial diff against the specified base is empty or fails, the command falls back to origin/<base>. Related error messages and warnings have been updated to reflect the chosen base. Unit tests have been added/updated to cover the new behavior.

Changes

  • cmd/prdescribe.go:

    • Added a new flag: --base (short: -b) with default value "master".
    • Updated runPRDescribe to use the flag value in git diff commands: first "<base>..HEAD --no-color", then falling back to "origin/<base>..HEAD --no-color" if needed.
    • Modified the "no changes" warning message to dynamically include the base branch (e.g., "No changes on this branch compared to develop/origin/develop.").

  • cmd/run_test.go:

    • Updated testCmd to register the new --base flag.
    • Added a new test: "uses custom base branch" – Verifies that setting --base=develop correctly passes "develop..HEAD" to the Git command and triggers the AI call.
    • Added a new test: "defaults to master" – Ensures the default base "master..HEAD" is used when no flag is provided.
    • Removed an outdated test ("second diff error — skips AI") that no longer aligns with the updated logic.

No breaking changes; the command behaves as before if --base is not specified.

Motivation

The existing prdescribe command hardcoded comparisons to main or origin/main, which assumes a specific branching model (e.g., GitHub Flow with main as the primary branch). Many repositories use alternative base branches like master, develop, or custom ones in Git Flow workflows. This flag provides users with the ability to customize the diff base without modifying the code, improving usability and adaptability for diverse project setups.

This change was inspired by potential user feedback or issues where the hardcoded main led to incorrect diffs in non-standard repos. It aligns with Cobra's flag-based configuration philosophy for CLI tools.

Testing Notes

  • Unit Tests:

    • New tests in cmd/run_test.go cover custom base usage (--base=develop), default behavior (master), and AI call triggering.
    • Tests use mocked Git and AI clients to isolate behavior.
    • Run go test ./cmd to verify. All tests pass locally.

  • Manual Testing:

    • Build the CLI and run prdescribe --base=develop in a repo with changes on a feature branch. Verify the diff is generated against develop (or origin/develop) and the AI description is produced.
    • Test fallback: In a repo without a local develop, ensure it tries origin/develop.
    • Edge case: Run with no changes; confirm the warning message includes the correct base.
    • Tested on macOS with Go 1.21; no issues observed. Recommend testing on Linux/Windows for cross-platform consistency.

  • Dependencies/Impact: No new dependencies. This is a low-risk change affecting only the prdescribe command.

If this looks good, please review and merge! Let me know if additional tests or adjustments are needed.

### Description This PR introduces a new `--base` (or `-b`) flag to the `prdescribe` command, allowing users to specify a custom base branch for generating Git diffs (e.g., comparing against `develop` instead of the default `master`). This enhances flexibility for repositories with non-standard branching strategies. The default remains `master` for backward compatibility. If the initial diff against the specified base is empty or fails, the command falls back to `origin/<base>`. Related error messages and warnings have been updated to reflect the chosen base. Unit tests have been added/updated to cover the new behavior. ### Changes - **cmd/prdescribe.go**: - Added a new flag: `--base` (short: `-b`) with default value `"master"`. - Updated `runPRDescribe` to use the flag value in `git diff` commands: first `"<base>..HEAD --no-color"`, then falling back to `"origin/<base>..HEAD --no-color"` if needed. - Modified the "no changes" warning message to dynamically include the base branch (e.g., "No changes on this branch compared to develop/origin/develop."). - **cmd/run_test.go**: - Updated `testCmd` to register the new `--base` flag. - Added a new test: "uses custom base branch" – Verifies that setting `--base=develop` correctly passes `"develop..HEAD"` to the Git command and triggers the AI call. - Added a new test: "defaults to master" – Ensures the default base `"master..HEAD"` is used when no flag is provided. - Removed an outdated test ("second diff error — skips AI") that no longer aligns with the updated logic. No breaking changes; the command behaves as before if `--base` is not specified. ### Motivation The existing `prdescribe` command hardcoded comparisons to `main` or `origin/main`, which assumes a specific branching model (e.g., GitHub Flow with `main` as the primary branch). Many repositories use alternative base branches like `master`, `develop`, or custom ones in Git Flow workflows. This flag provides users with the ability to customize the diff base without modifying the code, improving usability and adaptability for diverse project setups. This change was inspired by potential user feedback or issues where the hardcoded `main` led to incorrect diffs in non-standard repos. It aligns with Cobra's flag-based configuration philosophy for CLI tools. ### Testing Notes - **Unit Tests**: - New tests in `cmd/run_test.go` cover custom base usage (`--base=develop`), default behavior (`master`), and AI call triggering. - Tests use mocked Git and AI clients to isolate behavior. - Run `go test ./cmd` to verify. All tests pass locally. - **Manual Testing**: - Build the CLI and run `prdescribe --base=develop` in a repo with changes on a feature branch. Verify the diff is generated against `develop` (or `origin/develop`) and the AI description is produced. - Test fallback: In a repo without a local `develop`, ensure it tries `origin/develop`. - Edge case: Run with no changes; confirm the warning message includes the correct base. - Tested on macOS with Go 1.21; no issues observed. Recommend testing on Linux/Windows for cross-platform consistency. - **Dependencies/Impact**: No new dependencies. This is a low-risk change affecting only the `prdescribe` command. If this looks good, please review and merge! Let me know if additional tests or adjustments are needed.
gmgauthier added 1 commit 2026-03-04 18:14:42 +00:00
feat(prdescribe): add configurable base branch flag
Some checks failed
Auto-complete TODO / move-todo (pull_request) Failing after 1s
Details
CI / Test (pull_request) Successful in 34s
Details
CI / Lint (pull_request) Successful in 24s
Details
CI / Build (pull_request) Successful in 20s
Details
Release / Create Release (push) Successful in 35s
Details
b1d3a445ec 
Introduce a new --base flag (default: "master") to specify the base branch for diff comparison in the PR describe command. Update logic to use this base in git diff commands and fallback to origin/base. Adjust no-changes message accordingly. Add tests for custom base and default behavior.
gmgauthier merged commit d92b88e90b into master 2026-03-04 18:16:54 +00:00
gmgauthier deleted branch fix/add_base_branch_to_prdescribe 2026-03-04 18:16:55 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No Label
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: gmgauthier/grokkit#3
No description provided.
Delete Branch "fix/add_base_branch_to_prdescribe"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?