HOWTORELEASE

How to release

Publish a release

1. Check that the milestone is complete

2. Announce on Zulip

• "We are preparing the X.Y.Z version of mathcomp-analysis, please do not merge into master until further notice."

3. Edit the changelogs

• git checkout -b changelogXYZ
• Commit message: "changelog for version X.Y.Z"

4. Update INSTALL.md if necessary (version numbers, dependencies, etc.)

5. Check the opam file if necessary (tags, authors, description, etc.)

• NB: until version 0.5.4, the unique opam file used to be generated using https://github.com/coq-community/templates (and modifications were done in meta.yml)

5. Close the milestone

6. Generate the HTML documentation and PR to the MathComp website

• update the link to the last version of the doc in README.md

7. Draft the release

   • github.com/math-comp/analysis/releases/new
   • Tag: X.Y.Z
   • Title: "MathComp Analysis X.Y.Z"
   • Summary:
     • "Compatible with MathComp X.YZ, ..."
     • main change (extracted from the changelog?)
     • changelog

8. Announce to Zulip:

• "We have released the X.Y.Z version of mathcomp-analysis, it is now ok to merge into master. Changelog: https://github.com/math-comp/analysis/blob/master/CHANGELOG.md "

Publish the opam package

1. Submit a new opam package to https://github.com/coq/opam-coq-archive

• details omitted for now.

2. Annouce on Zulip:

• "The X.Y.Z version of mathcomp-analysis is available as an opam package in U." where U is among
  • https://coq.inria.fr/opam/released
  • https://coq.inria.fr/opam/extra-dev