Inputs

💡 Click on the Input Name for more Details.

Input	Req.	Default Value	Input Description
path	-	package-lock.json	Location of Lock File
update	-	true	Update Release Notes ⤵️
heading	-	### Package Changes	Release Notes Heading ⤵️
toggle	-	Click Here to View Changes	Toggle Text for Summary ⤵️
open	-	false	Summary Open by Default ⤵️
empty	-	false	Add Summary on No Changes ⤵️
columns	-	n,i,t,b,a	Customize Table Columns ⤵️
sections	-	a,u,d,r,k	Customize Package Sections ⤵️
max	-	30	Max Releases to Process
summary	-	true	Add Workflow Job Summary
token	-	github.token	For use with a PAT

For more details on inputs, see the VirusTotal API documentation.

See the Examples section for more options.

path

The path to the package lock file to proces.

Default: package-lock.json

update

Set this to false if you only want to use the Outputs.

Default: package-lock.json

heading

You can customize the heading or set to an empty string to remove it.

Default: ### Package Changes

toggle

The toggle must be set to a non-empty string if changing this input.

Default: Click Here to View Changes

open

Set summary to be open by default (note the first example below is open).

Default: false

empty

Set this to true to update release notes when no changes are detected.

Default: false

columns

Customize column visibility and order. This must be a perfectly formatted CSV with any combination of these keys:

Default: n,i,t,b,a

Key	Column	Column Description
n	Package Name	Name of the package
i	❔	Icon of the outcome
t	Outcome	Text of the outcome
b	Before	Version before change
a	After	Version after change

sections

Customize section visibility and order. This must be a perfectly formatted CSV with any combination of these keys:

Default: a,u,d,r,k

Key	Section	Section Description
a	Added	Newly added package
u	Upgraded	Updated package version
d	Downgraded	Downgraded package version
r	Removed	Removed package
k	Unknown	Invalid semantic version
n	Unchanged	Package version not changed

Note: Enabling Unchanged n packages can produce a very long list.

View the Column and Section Maps

const maps = {
  col: {
    n: { align: 'l', col: 'Package Name' },
    i: { align: 'c', col: '❔' },
    t: { align: 'c', col: 'Operation' },
    b: { align: 'l', col: 'Before' },
    a: { align: 'l', col: 'After' },
  },
  sec: {
    a: { icon: '🆕', text: 'Added', key: 'added' },
    u: { icon: '✅', text: 'Upgraded', key: 'upgraded' },
    d: { icon: '⚠️', text: 'Downgraded', key: 'downgraded' },
    r: { icon: '⛔', text: 'Removed', key: 'removed' },
    k: { icon: '❓', text: 'Unknown', key: 'unknown' },
    n: { icon: '🔘', text: 'Unchanged', key: 'unchanged' },
  },
}

max

Maximum number of releases to process when finding the latest.

Default: 30

summary

This will add a Job Summary to the workflow run. Set to false to disable.

Default: true

token

To use a different token, such as a PAT.

Default: github.token

Changelog Examples

💡 Click on an example heading to expand or collapse the example.

Note: Examples are generated with an empty header and default values.

Default Example

---

Click Here to View Changes

Changes for: package-lock.json

Package Name	❔	Before	After
@eslint/config-helpers	🆕		0.1.0
@eslint-community/eslint-utils	✅	4.4.1	4.5.1
@eslint/core	✅	0.11.0	0.12.0
@eslint/eslintrc	✅	3.2.0	3.3.0
@eslint/js	✅	9.20.0	9.22.0
@eslint/plugin-kit	✅	0.2.5	0.2.7
@humanwhocodes/retry	✅	0.4.1	0.4.2
@octokit/endpoint	✅	9.0.5	9.0.6
@octokit/graphql	✅	7.1.0	7.1.1
@octokit/plugin-paginate-rest	✅	9.2.1	9.2.2
@octokit/request	✅	8.4.0	8.4.1
@octokit/request-error	✅	5.1.0	5.1.1
acorn	✅	8.14.0	8.14.1
eslint	✅	9.20.1	9.22.0
eslint-scope	✅	8.2.0	8.3.0
flatted	✅	3.3.2	3.3.3
prettier	✅	3.5.0	3.5.3
@eslint/plugin-kit/node_modules/@eslint/core	⛔	0.10.0

Example with No Changes

---

No changes detected in: package-lock.json

More Changelog Examples Coming Soon...

For more options, see the Changelog Options.