Rewrite release instructions.

[trexfeathers]

🚀 Pull Request

Description

There are lots of simple steps to a release, making it easy to forget one or do one wrong. This is an ideal application for a do-nothing script, so I've written one.

I've also re-organised the docs page on releases, as that was proving difficult to follow logically. When reviewing it's probably easiest to read it as a new page, rather than trying to track the changes.

To-do:

• What's New entry
• Update after Updated citation #5116 is merged

---

Consult Iris pull request check list

[trexfeathers]

#5116 is going to conflict with this, but #5116 should probably go in first as it's much simpler

[ESadek-MO]

Until it's used with a release it probably won't be put through it's paces enough, but from a cursory overview running through locally, mostly just subjective suggestions.
Will hopefully do a deeper dive during next release.

[trexfeathers]

Thanks for the review @ESadek-MO 🙂

I think it makes sense to try this out in a real release before merging it, since it's so difficult to test. Note that this probably means the What's New entry goes somewhere else eventually.

[ESadek-MO]

Hey @trexfeathers. Here's some more comments, having used this in the latest release

[trexfeathers]

Thanks for giving this such a thorough test @ESadek-MO. I think I've addressed all your comments.

[codecov]

Codecov Report

Patch coverage has no change and project coverage change: +0.01 🎉

Comparison is base (21fd556) 89.31% compared to head (2abaab4) 89.32%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5134      +/-   ##
==========================================
+ Coverage   89.31%   89.32%   +0.01%     
==========================================
  Files          88       89       +1     
  Lines       22279    22390     +111     
  Branches     4881     5374     +493     
==========================================
+ Hits        19898    20000     +102     
- Misses       1635     1640       +5     
- Partials      746      750       +4     

see 6 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[ESadek-MO]

Thanks @trexfeathers, looks grand!
I think this will be a dynamic beastie, with edits coming with each release, but I really like where it's at now.