starburst997/Commits Log & Release

Generate changelog from commits between releases and optionally create a GitHub release

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
from-tagStarting tag for changelog (optional, will auto-detect latest vX.Y.Z tag if not provided)no""
to-tagEnding tag for changelog (optional, defaults to HEAD)no""
formatChangelog format: "simple" (one line per commit) or "grouped" (grouped by type)nogrouped
include-merge-commitsInclude merge commits in changelognofalse
changelog-titleTitle for the changelog sectionno## Changes
exclude-commitsExclude commits containing this text from changelognochore: update version
full-changelogAdd full changelog URL at the end of changelognotrue
create-tagCreate a new tag (auto-increments from latest tag)nofalse
version-bumpVersion bump type when auto-incrementing: "patch", "minor", or "major"nopatch
new-tagTag name for new release (only used if create-tag is true). Auto-increments if not provided.no""
create-releaseCreate a GitHub releasenotrue
git-pushPush commits and tags to remote repositorynofalse
tokenGitHub token for creating releasesno${{ github.token }}
release-nameRelease name.no""
release-bodyRelease body text. If empty, uses generated changelogno""
draftCreate a draft releasenofalse
prereleaseMark as a prereleasenofalse
make-latestMark as latest releasenotrue
generate-release-notesUse GitHub automatic release notes generation in addition to changelognofalse
auto-pick-notesAutomatically choose between GitHub's generateReleaseNotes (if PRs detected) or custom changelog (if no PRs). Overrides generate-release-notes when true.notrue
artifactsNewline-delimited list of artifact paths to uploadno""
artifact-content-typeContent type for artifactsnoapplication/octet-stream
commitCommit to tag for release creationno""
namedescription
changelogGenerated changelog content
changelog-filePath to the changelog file
from-tagTag used as starting point for changelog
to-tagTag used as ending point for changelog
latest-tagLatest vX.Y.Z tag found in the repository
release-tagTag without 'v' prefix for release name
new-tagNew tag that was created (if create-tag is true)
release-idID of the created release (only if create-release is true)
release-urlURL of the created release (only if create-release is true)
release-upload-urlUpload URL for the release (only if create-release is true)