Skip to content

Prints a formatted changelog between two tags or commit hashes.

Notifications You must be signed in to change notification settings

gandarez/changelog-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Changelog Action

This actions prints a formatted changelog.

Example usage

Basic

- id: changelog
  uses: gandarez/changelog-action@v{latest}
- name: "Print changelog"
  run: echo "${{ steps.changelog.outputs.changelog }}"

Advanced

- id: changelog
  uses: gandarez/changelog-action@v{latest}
  with:
    current_tag: "v0.2.8"
    previous_tag: "v0.2.2"
    main_branch_name: "trunk"
    exclude: |
        ^Merge pull request .*
        Fix .*
    debug: true
- name: "Print changelog"
  run: echo "${{ steps.changelog.outputs.changelog }}"

Inputs

parameter required description default
current_tag The current tag to be used instead of auto detecting.
previous_tag The previous tag to be used instead of auto detecting.
exclude Commit messages matching the regexp listed here will be removed from the output.
repo_dir The repository path. current dir
debug Enables debug mode. false

Outpus

parameter description
changelog The formatted changelog.