From 73cd213e640dc5d155044e3d29d09a7925d61cae Mon Sep 17 00:00:00 2001 From: Paul Natsuo Kishimoto Date: Sun, 24 Jan 2021 17:30:18 +0100 Subject: [PATCH] Add detail to release procedure --- doc/contrib/release.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/doc/contrib/release.rst b/doc/contrib/release.rst index 2726df040..930b11d7f 100644 --- a/doc/contrib/release.rst +++ b/doc/contrib/release.rst @@ -129,7 +129,13 @@ Releasing 9. Create a new release on GitHub. - Choose the existing tag ``v`` created/pushed earlier; *do not* create a new one. - - Add a link to the section in the “What's New” page of the documentation corresponding to the new release. + - For the description, provide a link to the section in the “What's New” page of the documentation that corresponds to the new release. + For example: + + .. code-block:: markdown + + See the [“What's New” page](https://docs.messageix.org/projects/ixmp/en/stable/whatsnew.html#v3-1-0-2020-08-28) in the ixmp documentation for a list of all changes. + 10. Update on conda-forge. A PR should automatically be opened by a bot after the GitHub release (sometimes this takes up to 30 minutes).