Go to file
Conventional Changelog Action 727448ac84 chore(release): v2.3.0 2020-05-08 08:22:04 +00:00
.github ci: Auto update the main tag 2020-05-08 10:20:35 +02:00
node_modules chore(release): v2.1.1 2020-04-29 08:09:23 +00:00
src feat: Added clean_changelog option 2020-05-08 10:19:41 +02:00
.gitignore chore: First test release 2019-10-18 09:40:38 +02:00
CHANGELOG.md chore(release): v2.3.0 2020-05-08 08:22:04 +00:00
LICENSE chore: Added LICENSE 2020-02-06 12:07:55 +01:00
README.md docs: Update README 2020-05-08 10:20:25 +02:00
action.yml feat: Added clean_changelog option 2020-05-08 10:19:41 +02:00
package.json chore(release): v2.3.0 2020-05-08 08:22:04 +00:00
yarn.lock fix: Pull full history so it works with checkout@v2 2020-04-29 10:03:43 +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, when providing false no file will be generated / updated.
  • Optional release-count: Number of releases to preserve in changelog. Default 5, use 0 to regenerate all.
  • Optional package-json: The path to the package.json to use. Default ./package.json.

Outputs

  • changelog: The generated changelog for the new version.
  • clean_changelog: The generated changelog for the new version without the version name in it (Better for Github releases)
  • version: The new version.
  • tag: The name of the generated tag.

Example usages

Uses all the defaults

- name: Conventional Changelog Action
  uses: TriPSs/conventional-changelog-action@v2
  with:
    github-token: ${{ secrets.github_token }}

Overwrite everything

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

No file changelog

- name: Conventional Changelog Action
  uses: TriPSs/conventional-changelog-action@v2
  with:
    github-token: ${{ secrets.github_token }}
    output-file: 'false'

Github releases

- name: Conventional Changelog Action
  id: changelog
  uses: TriPSs/conventional-changelog-action@v2
  with:
    github-token: ${{ secrets.github_token }}
    output-file: 'false'

- name: Create Release
  uses: actions/create-release@v1
  env:
   GITHUB_TOKEN: ${{ secrets.github_token }}
  with:
   tag_name: ${{ steps.changelog.outputs.tag }}
   release_name: ${{ steps.changelog.outputs.tag }}
   body: ${{ steps.changelog.outputs.clean_changelog }}