boromir674/Changelog Content Checker

Check CHANGELOG new Semantic Version markdown Section, before Release.

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stalelast commit Aug 27, 2024
License: AGPL 3.0

Pinned Snippet

workflow.ymlSHA-pinned

uses: boromir674/action-changelog-ci@d7c1c595e0213d0a6b53e8f5838bf940deaaae2a # v2.0.0

tags can be moved; commit SHAs can't. why a SHA?

Inputs

name	description	required	default
ref_to_check	Git Commit Ref with expected CHANGELOG changes. Defaults to HEAD, if value not passed	no	HEAD
main_branch	Main Branch of the Repository. Defaults to 'main', if value not passed. This should be the branch were code merges are done and possibly hosts the Semantically tagged commits/releases.	no	main
changelog_file	Path to CHANGELOG file. Defaults to 'CHANGELOG.md', if value not passed.	no	CHANGELOG.md
version_to_check	Require specific Semantic Version to be discovered in CHANGELOG. If not passed, rule defaults to requiring a Sem Ver (Reg Ex) pattern, to be found in markdown section header. If passed, rule requires a markdown section header with the exact version string.	no	—

Outputs

name	description
retval	Boolean as string, 'true' if CHANGELOG was updated according to the rules (ie has Semantic Version in a new Markdown Section), 'false' otherwise.