Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 3.86 KB

README.md

File metadata and controls

48 lines (35 loc) · 3.86 KB
Raw

generate-changelog-action

GitHub Action for lob/generate-changelog. Intended to be used with actions/create-release.

Created during the GitHub Actions Hackathon 2020 and selected as one of the winning projects!

Usage

Note: Your repository must contain a package.json file, although an empty file such as the one in this repository is fine.

If your package.json isn't available in root directory of your repository, you can pass the path of the package.json file by setting package-dir as follows:

- name: Changelog
  uses: scottbrenner/generate-changelog-action@master
  id: Changelog
  with:
    package-dir: 'root/to/my/package.json'

By default, this Action generates changelogs using commits between the previous tag and the most recent tag. Generate changelogs from specific tag or range (e.g. v1.2.3 or v1.2.3..v1.2.4) by passing the from-tag and to-tag inputs. An example is when your release tag on git is generated after the changelog so you must use something like git log v1..HEAD --oneline:

- name: Changelog
  uses: scottbrenner/generate-changelog-action@master
  id: Changelog
  with:
    from-tag: v1.0
    to-tag: HEAD

This Action additionally supports the following inputs, in accordance with lob/generate-changelog's CLI options.

Property Default Description
package-dir package.json The path for the package.json if it is not in root
from-tag "last tag" The tag to generate changelog from. If not set, fallbacks to git last tag -1. Ex.: v1.0
to-tag "current tag" The tag to generate changelog up to. If not set, fallbacks to git last tag. Ex.: v2.0
type Unset The type of changelog to generate: patch, minor, or major. If not set, fallbacks to unset.
exclude Unset Exclude selected commit types (comma separated). If not set, fallbacks to unset.
allow-unknown Unset Allow unknown commit types. If not set, fallbacks to unset.

For more information, see actions/create-release: Usage, lob/generate-changelog: Usage, and jobs.<job_id>.steps[*].with.

Example workflow - create a release

See this repository's release.yml for an example workflow which extends actions/create-release: Example workflow - create a release to generate a changelog from git commits and use it as the body for the GitHub release.

This workflow automatically creates this repository's releases.