bobankh/Auto-generate CHANGELOG

Generate CHANGELOG according to conventional commits automatically when released

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Activelast commit May 12, 2026
License
Apache 2.0

Pinned Snippet

workflow.ymlSHA-pinned
uses: bobankh/auto-generate-changelog@e8e1af1493032e025901cfdeb9ea6e67e4ffe208 # v1.3.2

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
REPO_NAMEThe name of the repo: user/repo_nameno""
ACCESS_TOKENGithub Access Token you want to use. Just pass GITHUB_TOKENyes
PATHPath to the file you want to add contributors' list. You can use <branch>:<file> format to specify the branchnoCHANGELOG.md
BRANCHThe branch to update file specified in PATHno""
PULL_REQUESTOpen a new pull request if set to a target branch nameno""
COMMIT_MESSAGECommit messagenodocs(changelog): update release notes
TYPEThe type of commits you want to add to CHANGELOGnofeat:Feature,fix:Fix
COMMITTERThe name and email of the committer. e.g. 'author <author@example.com>'no""
DEFAULT_SCOPEThe scope under which unscoped commits can be found e.g. 'fix: some general fix'nogeneral
SUPPRESS_UNSCOPEDSuppress the generation of release notes for un-scoped commits e.g. 'fix: some general fix'nofalse
UNRELEASED_COMMITSWhether to include unreleased commits in the changelognofalse
REGENERATE_COUNTRegenerate n recent releases' changelog. All non-exist releases will be generated. -1 means regenerating all the releases and 0 means no old releases will be regeneratedno0
REPLACE_EMPTY_RELEASE_INFOReplace empty release info with some wordsno*No description*

no outputs