mindsers/Changelog Reader
Read and parse the CHANGELOG file of the project
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| config_file | Path to a configuration file. If not specified, will look for .changelog-reader.json, .changelog-reader.yml, .changelog-reader.yaml, .changelogrc, or .changelogrc.json in the repository root | no | — |
| path | Path to the CHANGELOG file containing the log entries | no | ./CHANGELOG.md |
| version | Version of the log entry wanted | no | — |
| validation_level | Specifies if the CHANGELOG.md file should be validated and the behavior of the action | no | none |
| validation_depth | Specifies how many entries to validate in the CHANGELOG.md file | no | 10 |
| version_scheme | Versioning scheme used by the version identifiers in the CHANGELOG. One of: semver, pep440 | no | semver |
Outputs
| name | description |
|---|---|
| version | Version of the log entry found |
| date | Release date of the log entry found |
| status | Status of the log entry found. Possibly one of the following: prereleased, released, unreleased, or yanked |
| changes | Description text of the log entry found |
| changes_file | Path to a temporary file containing the description text of the log entry found. Useful for tools that take release notes as a file path (e.g. goreleaser --release-notes, gh release create --notes-file) |