Skip to content

README.md

Latest commit

 

History

History
42 lines (31 loc) · 1.52 KB

README.md

File metadata and controls

42 lines (31 loc) · 1.52 KB

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@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        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'