tomasbjerre/Git Changelog GitHub Release

Drafts release with template using Git Changelog Lib.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None

Inputs

namedescriptionrequireddefault
draftIf it should be a draft in GitHub or an actual releaseyestrue
ignoreTagPatternRegular expression. Any tag matching it will be ignored. no""
ignorePatternRegular expression. Any commit matching it will be ignored. yes^\[maven-release-plugin\].*|^\[Gradle Release Plugin\].*|^Merge.*|.*\[GRADLE SCRIPT\].*
minorVersionPatternCommits matching this pattern will trigger minor version step. yes^[Ff]eat.*
patchVersionPatternCommits matching this pattern will trigger patch version step. yes^(fix|chore\(deps\)).*
templateDraftUsed when draft is true. Unreleased changes rendered and used as description. See https://github.com/tomasbjerre/git-changelog-lib for documentation. no{{#tags}} {{#ifEquals name "Unreleased"}} {{#ifContainsBreaking commits}} # 💣 Breaking changes {{#commits}} {{#ifCommitBreaking .}} - {{#eachCommitScope .}} **{{.}}** {{/eachCommitScope}} {{{commitDescription .}}} ([{{subString hash 0 5}}](https://github.com/{{ownerName}}/{{repoName}}/commit/{{hash}}) {{authorName}}) {{#eachCommitRefs .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitRefs}} {{#eachCommitFixes .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitFixes}} {{/ifCommitBreaking}} {{/commits}} {{/ifContainsBreaking}} {{#ifContainsType commits type='feat'}} # 🚀 Features {{#commits}} {{#ifCommitType . type='feat'}} - {{#eachCommitScope .}} **{{.}}** {{/eachCommitScope}} {{{commitDescription .}}} ([{{subString hash 0 5}}](https://github.com/{{ownerName}}/{{repoName}}/commit/{{hash}}) {{authorName}}) {{#eachCommitRefs .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitRefs}} {{#eachCommitFixes .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitFixes}} {{/ifCommitType}} {{/commits}} {{/ifContainsType}} {{#ifContainsType commits type='fix'}} # 🐛 Bug Fixes {{#commits}} {{#ifCommitType . type='fix'}} - {{#eachCommitScope .}} **{{.}}** {{/eachCommitScope}} {{{commitDescription .}}} ([{{subString hash 0 5}}](https://github.com/{{ownerName}}/{{repoName}}/commit/{{hash}}) {{authorName}}) {{#eachCommitRefs .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitRefs}} {{#eachCommitFixes .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitFixes}} {{/ifCommitType}} {{/commits}} {{/ifContainsType}} {{#ifContainsTypeAndScope commits type="chore" scope="deps"}} # 📦 Dependency updates {{#commits}} {{#ifCommitType . type="chore"}} {{#ifCommitScope . scope="deps"}} - {{{commitDescription .}}} ([{{subString hash 0 5}}](https://github.com/{{ownerName}}/{{repoName}}/commit/{{hash}}) {{authorName}}) {{#eachCommitRefs .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitRefs}} {{#eachCommitFixes .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitFixes}} {{/ifCommitScope}} {{/ifCommitType}} {{/commits}} {{/ifContainsTypeAndScope}} {{#ifContainsType commits type='^($^|(?!fix|feat|breaking|chore).*)'}} # 🧰 Other changes {{#commits}} {{#ifCommitType . type='^$'}} **{{{messageTitle}}}** {{#messageBodyItems}} * {{.}} {{/messageBodyItems}} [{{subString hash 0 5}}](https://github.com/{{ownerName}}/{{repoName}}/commit/{{hash}}) {{authorName}} *{{commitTime}}* {{/ifCommitType}} {{/commits}} {{/ifContainsType}} {{/ifEquals}} {{/tags}}
templateLatestReleaseUsed when draft is false Difference between 2 latest tags rendered and used as description. See https://github.com/tomasbjerre/git-changelog-lib for documentation. no{{#with tags.[0]}} {{#ifContainsBreaking commits}} # 💣 Breaking changes {{#commits}} {{#ifCommitBreaking .}} - {{#eachCommitScope .}} **{{.}}** {{/eachCommitScope}} {{{commitDescription .}}} ([{{subString hash 0 5}}](https://github.com/{{ownerName}}/{{repoName}}/commit/{{hash}}) {{authorName}}) {{#eachCommitRefs .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitRefs}} {{#eachCommitFixes .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitFixes}} {{/ifCommitBreaking}} {{/commits}} {{/ifContainsBreaking}} {{#ifContainsType commits type='feat'}} # 🚀 Features {{#commits}} {{#ifCommitType . type='feat'}} - {{#eachCommitScope .}} **{{.}}** {{/eachCommitScope}} {{{commitDescription .}}} ([{{subString hash 0 5}}](https://github.com/{{ownerName}}/{{repoName}}/commit/{{hash}}) {{authorName}}) {{#eachCommitRefs .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitRefs}} {{#eachCommitFixes .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitFixes}} {{/ifCommitType}} {{/commits}} {{/ifContainsType}} {{#ifContainsType commits type='fix'}} # 🐛 Bug Fixes {{#commits}} {{#ifCommitType . type='fix'}} - {{#eachCommitScope .}} **{{.}}** {{/eachCommitScope}} {{{commitDescription .}}} ([{{subString hash 0 5}}](https://github.com/{{ownerName}}/{{repoName}}/commit/{{hash}}) {{authorName}}) {{#eachCommitRefs .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitRefs}} {{#eachCommitFixes .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitFixes}} {{/ifCommitType}} {{/commits}} {{/ifContainsType}} {{#ifContainsTypeAndScope commits type="chore" scope="deps"}} # 📦 Dependency updates {{#commits}} {{#ifCommitType . type="chore"}} {{#ifCommitScope . scope="deps"}} - {{{commitDescription .}}} ([{{subString hash 0 5}}](https://github.com/{{ownerName}}/{{repoName}}/commit/{{hash}}) {{authorName}}) {{#eachCommitRefs .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitRefs}} {{#eachCommitFixes .}}{{#ifMatches . "^#[0-9]+"}} [{{.}}](https://github.com/{{ownerName}}/{{repoName}}/issues/{{subString . 1}}) {{/ifMatches}}{{/eachCommitFixes}} {{/ifCommitScope}} {{/ifCommitType}} {{/commits}} {{/ifContainsTypeAndScope}} {{#ifContainsType commits type='^($|(?!fix|feat|breaking))'}} # 🧰 Other changes {{#commits}} {{#ifCommitType . type='^$'}} **{{{messageTitle}}}** {{#messageBodyItems}} * {{.}} {{/messageBodyItems}} [{{subString hash 0 5}}](https://github.com/{{ownerName}}/{{repoName}}/commit/{{hash}}) {{authorName}} *{{commitTime}}* {{/ifCommitType}} {{/commits}} {{/ifContainsType}} {{/with}}

Outputs

namedescription
idOf created release
html_urlOf created release
upload_urlOf created release
versionOf created release
descriptionThat was reated