Add a Changelog and automatic semantic versioning

cds-snc / covid-alert-server

Exposure Notification: Diagnosis Server implementation / Notification d’exposition : Mise en œuvre du serveur de diagnostic

Apache License 2.0

298 stars 31 forks source link

Add a Changelog and automatic semantic versioning #264

Open CalvinRodo opened 4 years ago

CalvinRodo commented 4 years ago

Add a changelog that uses the following format:

https://keepachangelog.com/en/1.0.0/

We can leverage the deleted FORK.md and documentation from CovidShield to prime it.

Acceptance criteria:

[ ] New PRs automagically update changelog
[ ] Changelog gets reconciled with version in master
[ ] GitHub automatically tags code with newest semantic version

maxneuvians commented 4 years ago

This is a more detailed audit of all the changes made to the server and allows somebody to review the changes chronologically. Using proper version numbers you could also have a much tighter release management process.

stephenyates-gc commented 4 years ago

Estimated effort is a day or two of research and implementation.

CalvinRodo commented 3 years ago

We might have to remove the requirement that branch protection rules apply to admins. We might want to have a couple of dedicated admin accounts for not only CI automation but also to ensure that we don't accidentally push to the main branch.