dangoslen/Changelog Enforcer
Enforces a repository changelog to be kept up to date.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| changeLogPath | Path to the changelog file relative to the repository | yes | CHANGELOG.md |
| skipLabels | "List of labels used to skip enforcing of the changelog during a pull request. Each label name is comma separated and only one label needs to be present for enforcement to be skipped. For example, if `label-1,label-2` was supplied as the `skipLabels`, `label-1` _or_ `label-2` would skip the enforcer. Each label is trimmed for leading and trailing spaces since GitHub labels do not allow for leading or trailing spaces. Thus, the following lists are equivalent: * `label-1,label-2` * `label-1 , label-2` * `label-1 ,label-2`" | yes | Skip-Changelog |
| expectedLatestVersion | The latest version of the software expected in the changelog. Should be in the form of 'v1.1.0' etc. | yes | "" |
| versionPattern | "A regex pattern used to extract the version section headings from the changelog. Changelog Enforcer assumes the use of the [KeepAChangelog.com](https://keepachangelog.com/en/1.0.0/) convention for section headings, and as such looks for a line starting with `## [version] - date`. Versions are only extracted from the changelog when enforcing the expected latest version (via the `expectedLatestVersion` property). If you supply your own regex to match a different format, your regex must match the version string as a capture group (in the default format, that's the part inside square brackets). The first capture group will be used if your regex includes multiple groups. The regex pattern is used with global and multiline flags to find all of the versions in the changelog. Because the regex is passed as a `String` object, you will need to escape backslash characters (`\`) via `\\`." | yes | ^## \[((v|V)?\d*\.\d*\.\d*-?\w*|unreleased|Unreleased|UNRELEASED)\] |
| missingUpdateErrorMessage | The error message logged and returned in the 'errorMessage' output when no update to the changelog has been found. | no | — |
| token | The secret value from your GITHUB_TOKEN or another token to access the GitHub API. Defaults to the token at `github.token` | yes | ${{ github.token }} |
Outputs
| name | description |
|---|---|
| errorMessage | A message containing the reason why the Changelog Enforcer failed. |