@@ -18,7 +18,7 @@ Preliminaries
18
18
and
19
19
`message-ix-feedstock <https://github.com/conda-forge/message-ix-feedstock >`__
20
20
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: ``.
22
22
23
23
- In the below:
24
24
@@ -45,7 +45,7 @@ For instance, an item marked as deprecated in v2.1 can be removed as of v3.0; an
45
45
46
46
.. note :: This can be done at any point, and should be done before the release prep begins.
47
47
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.
49
49
This is preferred, because it forces tutorials, user code, etc. to stay ahead of deprecations.
50
50
51
51
3. (message_ix only) Edit :file: `setup.cfg `, updating the ``install_requires `` line for ixmp as necessary.
@@ -72,12 +72,12 @@ Releasing
72
72
73
73
- Comment the heading "Next release", and insert below it:
74
74
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
77
77
- Another heading (``=== ``) below it, with the version number and date
78
78
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
81
81
82
82
For example, the top of the file should look like:
83
83
@@ -121,7 +121,7 @@ Releasing
121
121
Build the docs locally to ensure any ReST markup in these additions renders correctly.
122
122
123
123
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::
125
125
126
126
$ git tag vX.Y.ZrcN
127
127
$ git push --tags <upstream> release/X.Y.Z
0 commit comments