Pest: Normalize changelogs

Created on 11 Jun 2020  路  5Comments  路  Source: pestphp/pest

Across all the organisation some changelogs are missing dates, links, etc. They should all look like this: https://github.com/pestphp/pest/blob/master/CHANGELOG.md.

good first issue

Most helpful comment

I highly suggest looking into https://github.com/symplify/changelog-linker. I have started using it on all my older and new projects and its very clean and easy to you.

Example output: https://github.com/HDInnovations/UNIT3D-Community-Edition/blob/master/CHANGELOG.md

All 5 comments

I highly suggest looking into https://github.com/symplify/changelog-linker. I have started using it on all my older and new projects and its very clean and easy to you.

Example output: https://github.com/HDInnovations/UNIT3D-Community-Edition/blob/master/CHANGELOG.md

@nunomaduro
How do you think?
Is it right to use changelog-linker in terms of keep a changelog?
I think manual writing is the best way for users of the package.
Another option is to use the "changelog-linker" output to make manual adjustments (or fill partially) to the "changelog.md".

For now, I prefer to do it manually.

What we really need is:

  1. Go to every repository and make sure all of them have the https://keepachangelog.com/en/1.1.0/ format.
  2. Add missing links to pull requests / commits. Or at least most of them when we can't find.

I'll apply these changes to any of the repos I help maintain tomorrow. 馃憤

  • [x] [plugin](https://github.com/pestphp/pest-plugin/blob/master/CHANGELOG.md)
  • [x] [plugin-coverage](https://github.com/pestphp/pest-plugin-coverage/blob/master/CHANGELOG.md)
  • [x] [plugin-faker](https://github.com/pestphp/pest-plugin-faker/blob/master/CHANGELOG.md)
  • [x] [plugin-init](https://github.com/pestphp/pest-plugin-init/blob/master/CHANGELOG.md)
  • [x] [plugin-laravel](https://github.com/pestphp/pest-plugin-laravel/blob/master/CHANGELOG.md)
  • [x] [plugin-livewire](https://github.com/pestphp/pest-plugin-livewire/blob/master/CHANGELOG.md)

They seem to be normalised now.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

zingimmick picture zingimmick  路  3Comments

AlexMartinFR picture AlexMartinFR  路  6Comments

nunomaduro picture nunomaduro  路  7Comments

nunomaduro picture nunomaduro  路  4Comments

maks-rafalko picture maks-rafalko  路  6Comments