proposal: Switch from manual `CHANGELOG.md` to GitHub Releases - Githubissues

guardian / facia-scala-client

Low level client for the Facia JSON API

Other

2 stars 1 forks source link

proposal: Switch from manual `CHANGELOG.md` to GitHub Releases #275

Closed rtyley closed 2 years ago

rtyley commented 2 years ago

A CHANGELOG.md file is nice & compact, but requires manual formatting and doesn't integrate with GitHub's UI. GitHub Release notes have some advantages:

handy automation for writing release notes!
can be interrogated through the GitHub API
have a standard url: https://github.com/guardian/facia-scala-client/releases
have a standard place in the GitHub UI

This matches a similar move made earlier today with https://github.com/guardian/content-api-scala-client/pull/361!