Add automated CHANGELOG updates to ship-it job - #528
Open
ramonskie wants to merge 2 commits into
Open
Conversation
- Automatically updates CHANGELOG with commit messages since last release - Formats entries matching existing buildpack convention (scripts/bump) - Commits CHANGELOG with ci-skip marker to prevent pipeline re-trigger - Updates .git/ref so buildpack-github-release tags the CHANGELOG commit - Filters out Signed-off-by and Co-authored-by lines - Uses bash implementation as requested (team migrating away from Ruby)
ramonskie
force-pushed
the
update-changelog
branch
from
January 21, 2026 10:09
64130ee to
9982970
Compare
- Filter out merge commits (Merge pull request/branch) - Filter out version bump commits (Bump to X.Y.Z) - Filter out CI/config commits (Updating github-config, etc.) - Filter out test framework updates (switchblade, brats) - Filter out internal tooling commits - Skip duplicate commit subjects - Result: ~64% reduction in noise, keeping only user-facing changes (mainly dependency updates) Tested on python-buildpack v1.8.33..HEAD: 61 commits → 22 kept (all dependency updates)
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Automates CHANGELOG updates during buildpack releases in the
ship-itjob.Changes
New task:
tasks/update-changelog-for-release/scripts/bumpformat)[ci skip]message.git/refsobuildpack-github-releasetags the correct commitPipeline integration: Added task to
ship-itjobwrite-version-file, beforecheck-tag-not-already-added((cf-buildpacks-eng-github-ssh-key.private_key))Format
Matches existing CHANGELOG conventions across all CF buildpacks:
```
v1.10.28 Jan 20, 2026
Commit subject line
commit body indented by 2 spaces
Another commit
```
Implementation Details
Signed-off-by:andCo-authored-by:lines.git/refto ensure GitHub release tags the CHANGELOG commitComparison with
scripts/bumpThis implementation replicates the behavior of the existing
scripts/bumpRuby script, but:[ci skip]Testing Recommendations
[ci skip]messageRollback Plan
If issues occur, comment out the task in
pipelines/buildpack/pipeline.yml:```yaml
- task: update-changelog-for-release
file: buildpacks-ci/tasks/update-changelog-for-release/task.yml
params:
REPO_PRIVATE_KEY: ((cf-buildpacks-eng-github-ssh-key.private_key))
```
Then regenerate pipelines with
./bin/update-pipelines.