Skip to content
play

GitHub Action

Semantic Changelog Generator

v1.2.0 Latest version

Semantic Changelog Generator

play

Semantic Changelog Generator

Simple action that generates a pretty changelog from semantic commits

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Semantic Changelog Generator

              
  uses: nielstenboom/[email protected]
Learn more about this action in nielstenboom/semantic-changelog-generator

Choose a version

Semantic changelog generator

This action prints generates a pretty changelog from semantic commits.

example

Inputs

base

Required The base ref for git log

head

Required The head ref for git log

Outputs

changelog

The generated changelog

Example usage

# make sure to set fetch-depth to 0!
- uses: actions/checkout@v3
  with:
    fetch-depth: 0

- uses: nielstenboom/semantic-changelog-generator@v1
  id: changelog
  with:
    base: v1.0.0
    head: main

- name: Get the changelog
  run: |
    cat << "EOF"
    ${{ steps.changelog.outputs.changelog }}
    EOF

NOTE: if you want to enter branches with forward slashes in them, you should add 'origin/' in front

# make sure to set fetch-depth to 0!
- uses: actions/checkout@v3
  with:
    fetch-depth: 0

# point to branch with forward slashes with 'origin' prepended
- uses: nielstenboom/semantic-changelog-generator@v1
  id: changelog
  with:
    base: v1.0.0
    head: origin/my/branch/with/forward/slashes

- name: Get the changelog
  run: |
    cat << "EOF"
    ${{ steps.changelog.outputs.changelog }}
    EOF