Skip to content

Commit 69f0dc9

Browse files
Document GITHUB_TOKEN behavior: release commits won't trigger CI workflows
Co-authored-by: thomasturrell <1552612+thomasturrell@users.noreply.github.com>
1 parent 6e16a2c commit 69f0dc9

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

RELEASING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,14 @@ Result:
100100
- Used for reproducible builds and deployments
101101
- **No separate release branches**: The release workflow pushes directly to the originating branch
102102

103+
### CI Workflow Behavior
104+
105+
**Important**: Release commits pushed by the automated workflow will **not** trigger other CI workflows (such as build or test workflows). This is because the workflow uses the default `GITHUB_TOKEN`, and GitHub intentionally prevents workflows from triggering other workflows to avoid infinite loops.
106+
107+
- The release commits are still valid and properly signed by `github-actions[bot]`
108+
- Maven Central deployment happens within the release workflow itself
109+
- If you need CI to run on release commits, you would need to use a Personal Access Token (PAT) instead of `GITHUB_TOKEN`, though this is generally not recommended for releases
110+
103111
## Version Numbering
104112

105113
This project follows [Semantic Versioning](https://semver.org/):
@@ -188,6 +196,15 @@ If artifacts don't appear on Maven Central after a successful workflow:
188196
3. Check for any deployment errors in the workflow logs
189197
4. Verify GPG signing was successful (check for GPG-related errors)
190198

199+
### CI Workflows Not Triggered by Release Commits
200+
201+
**This is expected behavior**. Release commits pushed by the automated workflow will not trigger other CI workflows (such as build or test workflows). This is by design:
202+
203+
- The workflow uses the default `GITHUB_TOKEN` for authentication
204+
- GitHub prevents workflows triggered by `GITHUB_TOKEN` from triggering other workflows to avoid infinite loops
205+
- The release workflow already performs all necessary building, testing, and deployment within itself
206+
- If you need CI workflows to run on release commits (generally not recommended), you would need to configure a Personal Access Token (PAT) instead
207+
191208
## Required Secrets
192209

193210
The following GitHub secrets must be configured for releases to work:

0 commit comments

Comments
 (0)