README.md

Generate changelog

This action generates changelog based on the repository's commit messages written according to the Conventional Commits specification. It assumes Python, pip and Commitizen are already setup, see the setup Python action and setup Commitizen action for ready to use actions to do this.

There is also a ready-to-use workflow that uses this action.

Action inputs

Input	Description	Default
file_name	The name of the file to write the changelog to.	'CHANGELOG.md'

Example usage

name: 'Generate changelog'

on:
  push:
    branches:
      - main

jobs:
  generate_changelog:
    runs-on: ubuntu-latest
    steps:
      - name: 'Checkout repository'
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: 'Setup Python'
        uses: dfinity/ci-tools/actions/setup-python@main

      - name: 'Setup Commitizen'
        uses: dfinity/ci-tools/actions/setup-commitizen@main

      - name: 'Generate changelog'
        uses: dfinity/ci-tools/actions/generate-changelog@main
        with:
          file_name: 'CHANGES.md'