Skip to content

Automatically update a changelog to match the contents of all the GitHub releases.

Notifications You must be signed in to change notification settings

LizardByte/update-changelog-action

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 

Repository files navigation

update-changelog-action

GitHub Workflow Status (CI)

A reusable action to update a changelog, based on the contents of the GitHub releases.

Basic Usage

See action.yml

steps:
  - name: Update Changelog
    uses: LizardByte/update-changelog-action@master
    with:
      token: ${{ secrets.GITHUB_TOKEN }}

Inputs

Name Description Default Required
changelogBranch The branch to store the changelog in. changelog false
changelogFile The file to store the changelog in. CHANGELOG.md false
token GitHub Token. true

Outputs

Name Description
changelog The contents of the generated changelog.

See Also

This action is meant to be used in conjunction with LizardByte/setup-release-action.