covid-alert-server icon indicating copy to clipboard operation
covid-alert-server copied to clipboard

Add a Changelog and automatic semantic versioning

Open CalvinRodo opened this issue 5 years ago • 3 comments

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

CalvinRodo avatar Aug 24 '20 17:08 CalvinRodo

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.

maxneuvians avatar Nov 02 '20 18:11 maxneuvians

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

stephenyates-gc avatar Nov 02 '20 18:11 stephenyates-gc

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.

CalvinRodo avatar Nov 24 '20 20:11 CalvinRodo