crambl/dependabot-changelog-writer

Generate a changelog entry from a dependabot PR, then commit and push the changes

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stale
License: None

Inputs

name	description	required	default
changelog	Path of the changelog relative to the project root	yes	./CHANGELOG.md
changelog-entry-pattern	Template string defining how dependency updates are formatted in changelog entries. Uses [dep], [old], [new], [pr-link] as placeholder tokens for dependency name, old version, new version, and pull request link respectively. Tokens must appear in order: [dep], [old], [new]. The [pr-link] token is optional and may be specified at any position. Examples: - Pattern: '[dep]: [old] → [new]' produces 'npm: 1.0 → 1.2' - Pattern: 'Bump `[dep]` from [old] to [new]' produces 'Bump `npm` from 1.0 to 1.2' - Pattern: 'Bump [dep] from [old] to [new] ([pr-link])' produces 'Bump npm from 1.0 to 1.2 ([#1](https://github.com/user/repo/pull/1))'	yes	`[dep]`: [old] → [new] ([pr-link])
duplicate-entry-strategy	Strategy for handling duplicate dependency entries in changelog's unreleased section. When a Dependabot PR updates dependency FOO from B → C, but an unreleased entry already exists for FOO (A → B): 'overwrite': Replace existing entry with combined update (A → C) 'append': Keep existing entry and add new entry (B → C)	yes	overwrite
commit-message	The commit message for the changelog entry	yes	Updated changelog with updated dependencies
version	The version/H2 header to find in the CHANGELOG to add dependabot entries to matches whether or not the version is in brackets e.g. [0.1.0] and 0.1.0 are both valid. if set to 'unreleased' it will match 'unreleased' case-insensitive.	yes	unreleased
section-header	The section header to add the changelog entry under	yes	Dependencies
push-changes	Whether or not to add, commit, & push the modified changelog. Note: If no changes are made, no commit is made either.	yes	true
push-token	The GitHub token to use for git push, defaults to workflow token	yes	${{ github.token }}
action-download-token	The GitHub token to use for downloading the action, defaults to workflow token	yes	${{ github.token }}

Outputs

no outputs