Updating the change log.

[DigiLive]

Both of us forgot the change log.

Originally posted by @JBlond in https://github.com/JBlond/php-diff/issue_comments/707764891

[DigiLive]

Can something like this be implemented?
https://github.com/marketplace/actions/generate-changelog

[JBlond]

Yes we can. I have zero experience it in.

[DigiLive]

Haha... I don't have any experience with GitHub actions either.

It's gonna be a trial and error, I guess.

[JBlond]

I made a script for that (WIP). It can only track the changes after tagging so far.

See https://github.com/JBlond/php-diff/blob/automatic-changelog/changelog.sh
and
https://github.com/JBlond/php-diff/blob/automatic-changelog/changelog.md

maybe you have some additional ideas for that.

[DigiLive]

Looks promising so far.
My suggestions are:

• Don't include merge commits like: merge master into development
• Remove duplicate commit titles per release. (E.g. Fix #58 - Side by side diff shows empty diff is mentioned 3x)
• Include commits which where made after the latest release.
• Include links to Issues. (E.g. Fix Side by side diff shows empty diff #58 - Side by side diff shows empty diff)

I'm thinking about what's more sucker proof...

• Do we need to run the script manually (and won't we accidentally forget)?
• Assuming the script runs locally and because of cross-platform development, it might not be handy to have a single-platform script.

These points are inapplicable when running GitHub actions, I think.

[DigiLive]

Investigating GitHub actions, I came up with the following:
https://github.com/DigiLive/testChangelog/blob/master/.github/workflows/updateChangeLog.yml
(which operates on push events on the master branch for testing)

It uses https://github.com/github-changelog-generator/github-changelog-generator,
but I'm not sure when, what's included into the change log.
I think it depends on issues, PR's and their states and labels.

[DigiLive]

Please give https://github.com/DigiLive/gitChangelog a try.

It's also at Packagist. If you send me your account details, I can add you as a maintainer.

[JBlond]

I made a branch for that https://github.com/JBlond/php-diff/tree/66-automatic-changelog