-
Notifications
You must be signed in to change notification settings - Fork 0
feat(config): add integrationBranch setting and PR base branch guard #438
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| # Retort repo overlay settings | ||
| # This is retort's own overlay — configures how the framework generates output for itself. | ||
| repoName: retort | ||
| defaultBranch: main # Production branch — never commit directly | ||
| integrationBranch: dev # PRs must target dev, not main | ||
| primaryStack: auto | ||
| windowsFirst: true | ||
|
|
||
| aiSynthesisLayer: false | ||
|
|
||
| renderTargets: | ||
| - claude | ||
| - cursor | ||
| - windsurf | ||
| - copilot | ||
| - gemini | ||
| - codex | ||
| - warp | ||
| - cline | ||
| - roo | ||
| - ai | ||
| - mcp | ||
|
|
||
| featurePreset: standard |
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| <!-- GENERATED by Retort v{{version}} — DO NOT EDIT --> | ||
| <!-- Source: .agentkit/overlays/{{repoName}}/settings.yaml (integrationBranch) --> | ||
| <!-- Regenerate: pnpm -C .agentkit retort:sync --> | ||
| <!-- generated_by: {{lastAgent}} | last_model: {{lastModel}} | last_updated: {{syncDate}} --> | ||
| <!-- Format: Hookify guard rule. --> | ||
|
|
||
| # PR Base Branch Guard | ||
|
|
||
| Always use `--base {{integrationBranch}}` when creating pull requests in **{{repoName}}**. | ||
|
|
||
| ## Rule | ||
|
|
||
| **Event**: bash | ||
| **Action**: warn | ||
| **Pattern**: `gh pr create` without `--base {{integrationBranch}}` | ||
|
|
||
| ## Why This Matters | ||
|
|
||
| This repository uses a two-branch model: | ||
|
|
||
| - `{{defaultBranch}}` — production branch, never targeted directly by feature PRs | ||
| - `{{integrationBranch}}` — integration branch, the correct PR target for all feature work | ||
|
|
||
| Creating PRs against `{{defaultBranch}}` instead of `{{integrationBranch}}` triggers an automatic reverse-merge PR (merging `{{defaultBranch}}` back into `{{integrationBranch}}`), which creates noise and bypasses the integration pipeline. | ||
|
|
||
| ## Correct Usage | ||
|
|
||
| ```bash | ||
| # Always specify --base explicitly | ||
| gh pr create --base {{integrationBranch}} --title "type(scope): description" | ||
| ``` | ||
|
|
||
| ## Incorrect Usage | ||
|
|
||
| ```bash | ||
| # These will target the wrong branch | ||
| gh pr create --title "type(scope): description" | ||
| gh pr create --base {{defaultBranch}} --title "type(scope): description" | ||
| ``` | ||
|
|
||
| ## Configuration | ||
|
|
||
| The integration branch is configured in `.agentkit/overlays/{{repoName}}/settings.yaml`: | ||
|
|
||
| ```yaml | ||
| defaultBranch: {{defaultBranch}} | ||
| integrationBranch: {{integrationBranch}} | ||
| ``` | ||
|
|
||
| To change the integration branch, update `settings.yaml` and run `pnpm -C .agentkit retort:sync`. |
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
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
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
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
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
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
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same issue as the Bash template: the message mixes
Retortwithagentkit-forge repository. Align the wording (or make the upstream repo name configurable) so PowerShell users get the same accurate guidance as Bash users.