onesoft-sudo/conventional-release-action

A GitHub Action to automatically tag and create releases based on conventional commits.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
allowed-commit-typesA comma-separated list of commit types that are allowed.no
version-json-fileThe path to one or more JSON file(s) that contains the version information.no
version-manager-moduleThe path to a commonjs module that exports a function to manage the version.no
json-tab-widthThe number of spaces to use for indentation in the JSON file.no4
create-tagWhether to create a tag for the new version.notrue
create-commitWhether to create a commit for the new version.notrue
create-tag-prefixThe prefix to use for the tag.nov
commit-message-formatThe format to use for the commit message.nochore(release): v%s [skip ci]
git-pathThe path to the git executable.no/usr/bin/git
git-user-nameThe name to use for the git user.noConventional Release Action
git-user-emailThe email to use for the git user.noconventional-release@onesoftnet.eu.org
git-gpg-keyThe GPG key (ASCII) to use for signing the commit.no
git-sign-offWhether to sign off the commit.nofalse
git-pushWhether to push the commit and tag.notrue
git-push-remoteThe remote to push the commit and tag to.noorigin
git-push-remote-urlThe URL of the remote to push the commit and tag to.no
git-push-branchThe branch to push the commit and tag to.no
metadata-fileThe path to the file that contains the metadata.no.github/cra-metadata.json
changelog-fileThe path to the file where the generated changelog will be written.noChangeLog
changelog-formatThe format to use for the changelog. Can be 'markdown' or 'plain'.noplain
add-release-notesWhether to add release notes to the changelog.notrue
skip-commits-patternA regex pattern for the commits which should not be listed in the release notesno^release(\(.+?\))?\!?:
skip-commits-pattern-flagsFlags for the regex pattern in skip-commits-patternnogi
namedescription
versionThe new version.
tagThe new tag.
release_notesThe generated release notes.