Skip to content

Documented the classic-branch-protection setup gap in the GitHub App … #5

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.

Sign up for GitHub

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
funkyshu merged 1 commit into from
Jun 18, 2026
+16 −1
Merged

Documented the classic-branch-protection setup gap in the GitHub App … #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Documentation
- Documented the classic-branch-protection setup gap in the GitHub App Setup
section: the app must be added to both the "Allow specified actors to bypass
required pull requests" list and the "Restrict who can push" allowlist, or
the push fails with `protected branch hook declined`. Rulesets only need a
single bypass entry.

## [[v1.1.0](https://github.com/C2FO/releasegen/releases/tag/v1.1.0)] - 2026-06-18
### Security
- Update dependenices to resoolve dependabot security alerts
Expand Down
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,15 @@ If your release branch is protected (required reviews, status checks, etc.), the
4. **Add repository secrets** (Settings → Secrets and variables → Actions):
- `RELEASEGEN_APP_ID` = your App ID
- `RELEASEGEN_APP_PRIVATE_KEY` = contents of the `.pem` file
5. **Allow the app to bypass branch protection** (Settings → Rules → your `main` ruleset → **Bypass list** → add the app).
5. **Allow the app to bypass branch protection.** How you do this depends on which protection style your release branch uses:
- **Rulesets (recommended):** Settings → Rules → your release-branch ruleset → **Bypass list** → add the app. One list, done.
- **Classic branch protection:** Settings → Branches → edit the rule for your release branch and update **two** separate lists:
1. Under **Require a pull request before merging** → check **Allow specified actors to bypass required pull requests** → add the app.
2. Under **Restrict who can push to matching branches** → add the app to the push allowlist.

> **Heads up (classic protection):** the push allowlist alone is **not** enough. GitHub's docs are explicit: "People, teams, and apps that have permission to push to a protected branch will still need to create a pull request when pull requests are required." The push will fail with `protected branch hook declined` until the app is also in the pull-request bypass list. If you're on classic protection and want a single place to manage this, consider migrating the branch to a Ruleset.

Repeat for every protected branch the workflow releases from (e.g. `main`, `v6`, etc.).

### Workflow Example

Expand Down
Loading