Package Changelog Action

Action to Generate Package Changelog. View some Changelog Examples.

On a release, this action will parse the differences in the provided package-lock.json file between the current and previous release and update the release notes with a table of changes.

On a prerelease it compares with the previous release, on a non-prerelease release, it compares with the previous non-prerelease. Packages get sorted into the following categories and columns:

Name	❔	Operation	Before	After
@added	🆕	Added		current
@upgrade	✅	Upgraded	previous	current
@downgraded	⚠️	Downgraded	previous	current
@removed	⛔	Removed	previous
@unknown	❓	Unknown	previous	current
@unchanged	🔘	Unchanged	previous	current

Workflow

Add the step to an existing workflow or create a new one.

Existing Workflow

- name: "Package Changelog Action"
  continue-on-error: true
  uses: cssnr/package-changelog-action@v2

New Workflow

name: "Release"

on:
  release:
    types: [published]

jobs:
  release:
    name: "Release"
    runs-on: ubuntu-latest
    timeout-minutes: 5

    permissions:
      contents: write

    steps:
      - name: "Package Changelog Action"
        continue-on-error: true
        uses: cssnr/package-changelog-action@latest

Hash Copied to Clipboard

Check out the Rolling Tags for more tag options.

Make sure to add the required Permissions.

See the Inputs Documentation for additional options and default values.

Permissions

This action requires the following permissions to edit releases notes:

permissions:
  contents: write

Permissions documentation for Workflows and Actions.