All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Introduced changelog validation to help keep the release version in line with Semantic Versioning
- New input param of
validation_depth
to allow for configuration of changelog validation.
- The project now implement the All Contributors. This is not a change in the code but a change in how the projet recognize the external contributions.
2.0.0 - 2020-08-30
- New output properties:
- The
version
number of the returned entry - The released
date
of the returned entry - The
status
of the release based on the version number and the title line of the entry. Could be equal tounreleased
,prereleased
,released
oryanked
. Please refer to https://semver.org/#semantic-versioning-specification-semver for more informations about this.
- The
- [BREAKING CHANGE] If given a specific target version, action will now generate an error response if that version is not found in the changelog.
- [BREAKING CHANGE]
log_entry
output property is renamed tochanges
.
1.3.1 - 2020-07-08
- Allow developers to NOT use a date for each version entries.
1.3.0 - 2020-07-06
- Dates should follow the format used in the "Keep a Changelog" specification
which is
YYYY-MM-DD
. Another format that may work isYYYY-DD-MM
. Given the current disclaimer in theREADME.md
, this change is not a breaking change.
- Improve SEMVER support. Now recognize complex version number based on https://semver.org.
1.2.0 - 2020-06-24
- New support for "Unreleased" section. It is possible to ask for the "Unreleased" section
by setting
version: "Unreleased"
in theworkflow.yml
file.
- Improve the way the project is linted
1.1.0 - 2020-03-13
- The project has now a CHANGELOG
- Add logging message to make the debugging session easier
- When no log entry is found, the error state of the action doesn't break the workflow anymore
- README now uses the correct version number in the examples
- Support X.X.X version pattern
1.0.1 - 2020-02-12
- Remove template's old behavior
1.0.0 - 2020-02-12
- CHANGELOG can be parsed by the github action