Repository files navigation

Automatic Changelog generator

• Usage
• Inputs
  • Github Token
  • Commit Types
  • Default Commit Type
  • Release Name
  • Release Name Prefix
  • Mention Authors
  • Mention New Contributors
  • Include GitHub Compare Link
  • SemVer Compatibility
  • Use GitHub Autolink
• Outputs
  • Changelog
  • Pre-release
  • Release ID
• Example Usage

To use this action, your commit messages have to follow the format below:

type(category): description [flag]

• Thetype must be one ofcommit-types input keys. In the changelog output, the value will be used.

  The changelogs will be in the same order ascommit-types input.

  If thetype doesn't match any of the providedcommit-types input keys, Thedefault-commit-type input will beused instead.

• Thecategory is optional and can be anything of your choice.

• Theflag is optional (if provided, it must be surrounded in square brackets) and can be one of the followings:

  • ignore (Omits the commit from the changelog)

  Ifflag is not found in the list, it'll be ignored.

Commit messages not matching the format mentioned above will be ignored in thechangelog output.

(Optional)

Github token.

Default:

${{ github.token }}

(Optional)

Commit types.

The default value is based on theConventional Commits Specification

Default:

feat:New Featuresfix:Bug Fixesbuild:Build System & Dependenciesperf:Performance Improvementsdocs:Documentationtest:Testsrefactor:Refactorschore:Choresci:CIstyle:Code Stylerevert:Reverts

(Optional)

Default commit type.

This input will be used when the commit message matches none of the definedcommit-types input.

Default:

Other Changes

(Optional)

Release name (version, e.g.v1.0.0).

Default:

${{ github.ref_name }}

(Optional)

Release name (version) prefix.

Example: For a release name such as@actions/github/v1.0.0 it would be@actions/github/

Default:

""

(Optional)

Mention the author of each commit.

Default:

true

(Optional)

Mention new contributors at the bottom of the changelog (New Contributors).

Default:

true

(Optional)

Include GitHub compare at the bottom of the changelog (Full Changelog).

If there is no previous tag determined it'll be ommited regardless of the provided value.

Default:

true

(Optional)

Include GitHub pull request links at each log if applicable.

Default:

true

(Optional)

Include GitHub commit links at each log.

Default:

true

(Optional)

Enable semver based version comparison.

If enabled it'll determine whether the github ref is a valid semver string,it'll fail the action in case it's not.

It'll then determine whether the version is a pre-release or not,if it is, the previous version will be selected from any version (pre-release or not) lesser than the current ref,if current ref is not a pre-release,the previous version will be selected only from the latest version (not pre-release) lesser than the current ref.

Default:

true

(Optional)

UseGitHub Autolink.

Default:

true

The generated changelog.

Indicates whether it's a pre-release or not.

if semver is set totrue, otherwise this output will always returnfalse.

The pre-release id in case of prerelease beingtrue,latest otherwise. (e.g.alpha,beta,rc,canary)

if semver is set totrue, otherwise this output will always returnlatest.

Using with default inputs:

-name:Changeloguses:ardalanamini/auto-changelog@v4id:changelog

Using with custom inputs:

-uses:ardalanamini/auto-changelog@v4id:changelogname:Changelogwith:github-token:${{ github.token }}commit-types            :|      feat    : New Features      fix     : Bug Fixes      build   : Build System & Dependencies      perf    : Performance Improvements      docs    : Documentation      test    : Tests      refactor: Refactors      chore   : Chores      ci      : CI      style   : Code Style      revert  : Revertsdefault-commit-type:Other Changesrelease-name:v1.0.0release-name-prefix:""mention-authors:truemention-new-contributors:trueinclude-compare-link:trueinclude-pr-links:trueinclude-commit-links:truesemver:trueuse-github-autolink:true