Generic Conventional Changelog GitHub Action

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/[email protected]
    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.