Introduces a CHANGELOG file to follow updates on this project

[llaville]

To follow changes on this project, adding a CHANGELOG.md file that respect this https://keepachangelog.com/en/1.1.0/ syntax, would be a great add-ons

[dgafka]

@llaville I think make sense to add this. Is there github action workflow that could produce those from github releases?

[llaville]

@dgafka Yes there are many solutions. Personally I used https://github.com/miniscruff/changie that can use in an automated way or manually via CLI
This is the last way I used it myself in my projects.

For example with one of my project :

• release notes => https://github.com/llaville/sarif-php-sdk/tree/master/.changes/2.x
• basic config file => https://github.com/llaville/sarif-php-sdk/blob/master/.changie.yaml
• include the release notes in my GH workflow => https://github.com/llaville/sarif-php-sdk/blob/master/.github/workflows/release.yml#L122-L133
• final CHANGELOG file generated from release notes => https://github.com/llaville/sarif-php-sdk/blob/master/CHANGELOG.md

You can find alternative solutions from : https://github.com/topics/changelog

Two of them

• https://github.com/orhun/git-cliff
• https://github.com/marcocesarato/php-conventional-changelog

[dgafka]

Thanks for the idea @llaville, we are live with changelog:

https://github.com/ecotoneframework/ecotone-dev/blob/main/CHANGELOG.md

[llaville]

@dgafka Thanks for the quick implementation.
It will help people that follow the project to lean easily what have changed between releases without to read it online on https://github.com/ecotoneframework/ecotone-dev/releases and paginate to see all notes.