Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
layers

GitHub Action

Generic Conventional Changelog

v1.1.0

Generic Conventional Changelog

layers

Generic Conventional Changelog

Generates a changelog from conventional commit history between two given references

Installation

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

 
              
- name: Generic Conventional Changelog

              
  uses: dlavrenuek/conventional-changelog-action@v1.1.0
Learn more about this action in dlavrenuek/conventional-changelog-action

Choose a version

Generic Conventional Changelog GitHub Action

javscript-action status

This GitHub action generates a changelog from git history using conventional commits without any other requirements on your project versioning or labeling. It is intended to be used with other actions to make use of the generated changelog.

Example Usage

This example generates a changelog from the tag v1.0.0 to HEAD

steps:
  - uses: actions/checkout@v2
    with:
      fetch-depth: 0

  - uses: dlavrenuek/conventional-changelog-action
    id: changelog
    with:
      from: v1.0.0
      to: HEAD

The changelog can be accessed in other steps by ${{ steps.changelog.outputs.body }}

Input Variables

Inputs available through with:

Input Description Required
from Commit SHA, tag or reference as starting point for the changelog ✔
to Commit SHA, tag or reference as ending point for the changelog ✔
config-file Path to the configuration file to override default configuration

The default configuration can be found in defaultConfig.json

Output Variables

Inputs available through outputs:

Output Description
body The changelog body
bump Recommended bump based on the provided configuration

Complete workflow

A complete workflow for creating a draft release can be found here.

Example output

## ⚡️ Breaking Changes

- finalize v1 release ([#5](https://github.com/dlavrenuek/conventional-changelog-action/issues/5))

## 🚀 New Features

- Add a feature

## 💊 Bugfixes

- fix some bug
- fix another bug

## 🧹 Chore

- add deps-dev as commit scope

Contribute

If you want to contribute, feel free to open an issue or a pull request.