Automates CHANGELOG.md generation and draft release note management using Gemini AI, triggered on every GitHub Release event.#452
Open
vibhutikumar07 wants to merge 3 commits intodevelopfrom
Open
Conversation
Adds fully automated CHANGELOG.md generation on every GitHub Release event,
plus a Release Drafter for keeping the GitHub Release body up-to-date as PRs
are merged to develop.
New files:
- .github/scripts/generate-changelog.js
Gemini-powered script that finds PRs and commits since the last tag,
calls Gemini Flash to write a structured changelog entry matching the
project's existing ## Version / ### Added / ### Fixed format, and
prepends it to CHANGELOG.md. Includes a structured fallback (from PR
labels) in case the Gemini API is unavailable.
- .github/workflows/changelog.yml
Triggers on both prereleased and released GitHub Release events.
Checks out develop, runs the Gemini script, then commits and pushes
the updated CHANGELOG.md with git pull --rebase to avoid conflicts
with the concurrent newrelease version-bump commit.
- .github/release-drafter.yml
Configuration for release-drafter: categorizes PRs by label into
Breaking Changes, New Features, Bug Fixes, Security, Performance,
Documentation, Dependency Updates. Generates next semver automatically
and populates the GitHub Release body draft.
- .github/workflows/release-drafter.yml
Triggers on push to develop and on PR events to keep the draft
release body current as work lands.
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
1 participant
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.
Describe your changes
How It Works:
On every release (released), the changelog.yml workflow runs
generate-changelog.js resolves the previous tag (e.g. 1.7.0 → 1.8.0), fetches all merged PRs and commits in that range
Gemini Flash writes a structured ## Version X.Y.Z / ### Added / ### Fixed / ### Changed entry using full project context (CAP SDM, CMIS, tenant handling, etc.)
If GEMINI_API_KEY is unavailable, a structured fallback groups PRs by their GitHub labels
The entry is prepended to CHANGELOG.md and pushed back to develop via git pull --rebase + git push
In parallel, release-drafter keeps a draft release auto-updated as PRs land on develop
Any documentation
Type of change
Please delete options that are not relevant.
Checklist before requesting a review
Upload Screenshots/lists of the scenarios tested