What problem does your feature request solve?
The release documentation at https://metoffice.github.io/CSET/contributing/releases.html is out of date (at least on writing the release notes). Furthermore I am the only person who knows the full release process, and it would be good to document this in case I get hit buy a bus or win the lottery.
Describe the solution you'd like
Make a release script for CSET, so you can just do make release. Do as an executable instruction script, pausing whenever a manual step is needed. The script should:
- Automate release note generation, dropping the headings for simplicity.
- Leave placeholder and get user to write prose description.
- Push to GitHub and make PR adding release notes.
- Once merged, tag release and push tag to GitHub, and API request to make the release.
- Provide instructions (or GitHub API and open issue triggering the auto-update bot) for updating the conda-forge repository.
- Finally provide notice that the conda-forge CDN will take a while to update.
The documentation will need to be updated to note that this script should be run.
Describe alternatives you've considered
We could just update the documentation with the manual steps, however there is value in automation to minimise mistakes. Additionally, having the script be executed every time a release is made will ensure it remains up-to-date with the process, rather than risking the documentation getting out-of-date.
What problem does your feature request solve?
The release documentation at https://metoffice.github.io/CSET/contributing/releases.html is out of date (at least on writing the release notes). Furthermore I am the only person who knows the full release process, and it would be good to document this in case I get hit buy a bus or win the lottery.
Describe the solution you'd like
Make a release script for CSET, so you can just do
make release. Do as an executable instruction script, pausing whenever a manual step is needed. The script should:The documentation will need to be updated to note that this script should be run.
Describe alternatives you've considered
We could just update the documentation with the manual steps, however there is value in automation to minimise mistakes. Additionally, having the script be executed every time a release is made will ensure it remains up-to-date with the process, rather than risking the documentation getting out-of-date.