Go to file

Tycho Bokdam 176eaba225 Merge pull request #16 from TriPSs/master Update README		2020-04-16 10:17:01 +02:00
.github/workflows	ci: Updated main.yml	2019-10-18 11:57:45 +02:00
node_modules	chore(release): v2.0.0	2020-04-16 08:14:32 +00:00
src	refactor: Changed int 5 to string 5 as default value	2020-04-16 10:11:29 +02:00
.gitignore	chore: First test release	2019-10-18 09:40:38 +02:00
CHANGELOG.md	chore(release): v2.0.0	2020-04-16 08:14:32 +00:00
LICENSE	chore: Added LICENSE	2020-02-06 12:07:55 +01:00
README.md	docs: Update README	2020-04-16 10:16:09 +02:00
action.yml	refactor: Changed int 5 to string 5 as default value	2020-04-16 10:11:29 +02:00
package.json	chore(release): v2.0.0	2020-04-16 08:14:32 +00:00
yarn.lock	chore: Update deps	2020-04-16 10:09:11 +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'
    release-count: '5'