laughedelic / auto-changelog

Github Automatic Changelog action

Home Page:https://github.com/marketplace/actions/auto-changelog

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Auto Changelog

Automatic Changelog generator

Usage

To use this action, your commit messages have to follow the format below:

type(category): description [flag]

The type must be one of the followings:

  • breaking
  • build
  • ci
  • chore
  • docs
  • feat
  • fix
  • other
  • perf
  • refactor
  • revert
  • style
  • test

If the type is not found in the list, it'll be considered as other.

The category is optional and can be anything of your choice.

The flag is optional (if provided, it must be surrounded in square brackets). (eg. breaking)

Inputs

token

Required Github token.

exclude

Exclude selected commit types (comma separated).

Outputs

changelog

The generated changelog.

Example usage

uses: ardalanamini/auto-changelog@v1.0.0
with:
  token: ${{ secrets.GITHUB_TOKEN }}
  exclude: 'perf,other,breaking'

About

Github Automatic Changelog action

https://github.com/marketplace/actions/auto-changelog

License:MIT License


Languages

Language:JavaScript 96.9%Language:TypeScript 3.1%