Skip to content

Commit 8c0b9f2

Browse files
committed
Update release procedure
1 parent 6554f0a commit 8c0b9f2

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

doc/contrib/release.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Preliminaries
1818
and
1919
`message-ix-feedstock <https://github.com/conda-forge/message-ix-feedstock>`__
2020
repositories.
21-
This means your Github account is listed in the :file:`recipe/meta.yaml`, under the key ``recipe-maintainers:``.
21+
This means your Github account is listed in each of them in the :file:`recipe/meta.yaml`, under the key ``recipe-maintainers:``.
2222

2323
- In the below:
2424

@@ -45,7 +45,7 @@ For instance, an item marked as deprecated in v2.1 can be removed as of v3.0; an
4545

4646
.. note:: This can be done at any point, and should be done before the release prep begins.
4747
For instance, a feature marked as deprecated in v2.0 *should* be removed before 3.0 is released.
48-
But *may* also be removed from the ``master`` branch *immediately after* 2.0.0 is released.
48+
But *may* also be removed from the ``main`` branch *immediately after* 2.0.0 is released.
4949
This is preferred, because it forces tutorials, user code, etc. to stay ahead of deprecations.
5050

5151
3. (message_ix only) Edit :file:`setup.cfg`, updating the ``install_requires`` line for ixmp as necessary.
@@ -72,12 +72,12 @@ Releasing
7272

7373
- Comment the heading "Next release", and insert below it:
7474

75-
- A commented "All changes" sub-heading (``---``).
76-
- A ReST anchor with the version number.
75+
- A commented "All changes" sub-heading (``---``)
76+
- A ReST anchor with the version number
7777
- Another heading (``===``) below it, with the version number and date
7878

79-
- Add a short text description summarizing the release.
80-
- If necessary, add a subsection "Migration notes" explaining to users how to adjust to changes in the release.
79+
- Add a short text description summarizing the release
80+
- If necessary, add a subsection "Migration notes" explaining to users how to adjust to changes in the release
8181

8282
For example, the top of the file should look like:
8383

@@ -121,7 +121,7 @@ Releasing
121121
Build the docs locally to ensure any ReST markup in these additions renders correctly.
122122

123123
3. Make a commit with a message like “Mark v<version> in release notes”.
124-
4. Tag the release candidate version, i.e. with a ``rcN`` suffix, and push::
124+
4. Tag the release candidate version, i.e. with a ``rcN`` suffix where ``N`` is a natural number, and push::
125125

126126
$ git tag vX.Y.ZrcN
127127
$ git push --tags <upstream> release/X.Y.Z

0 commit comments

Comments
 (0)