Go to file
Tycho Bokdam 2cb662b4fe
chore: Added LICENSE
2020-02-06 12:07:55 +01:00
.github/workflows ci: Updated main.yml 2019-10-18 11:57:45 +02:00
src feat: Make the releaseCount configurable 2020-02-04 14:19:48 +02:00
.gitignore chore: First test release 2019-10-18 09:40:38 +02:00
LICENSE chore: Added LICENSE 2020-02-06 12:07:55 +01:00
README.md fixed typo, README 2020-02-04 15:25:13 +02:00
action.yml feat: Make the releaseCount configurable 2020-02-04 14:19:48 +02:00
package.json fix: Test release 2019-10-18 11:33:55 +02:00
yarn.lock fix: Test release 2019-10-18 11:33:55 +02:00

README.md

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.
  • Optional changelog-release-count: Number of releases to preserve in changelog. Default 5, use 0 to regenerate all.

Example usage

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