conventional-changelog-action/README.md

808 B

Conventional Changelog action

This action will bump version, tag commit and generate a changelog with conventional commits.

Inputs

-Required github-token: Github token. -Optional git-message: Commit message that is used when committing the changelog. -Optional preset: Preset that is used from conventional commits. Default angular. -Optional tag-prefix: Prefix for the git tags. Default v. -Optional output-file: File to output the changelog to. Default CHANGELOG.md.

Example usage

- name: Conventional Changelog Action
  uses: TriPSs/conventional-changelog-action@v0.0.1
  with:
    github-token: ${{ secrets.github_token }}
    git-message: 'chore(release): {version}'
    preset: 'angular'
    tag-prefix: 'v'
    output-file: 'CHANGELOG.md'