@@ -206,9 +206,12 @@ it is important to move all branches away from the commit with the tag [#]_::
206
206
207
207
Finally, push the tag to GitHub::
208
208
209
- git push DANGER main v2.0.0
209
+ git push DANGER v2.0.x v2.0.0
210
210
211
211
Congratulations, the scariest part is done!
212
+ This assumes the release branch has already been made.
213
+ Usually this is done at the time of feature freeze for a minor release (which often
214
+ coincides with the last patch release of the previous minor version)
212
215
213
216
.. [# ] The tarball that is provided by GitHub is produced using `git archive `_.
214
217
We use setuptools_scm _ which uses a format string in
@@ -236,15 +239,29 @@ done for pre-releases)::
236
239
git branch v2.0.0-doc
237
240
git push DANGER v2.0.0-doc
238
241
239
- and if this is a major or minor release, also create a bug-fix branch (a micro
240
- release will be cut from this branch)::
242
+ Update (or create) the ``v2.0-doc `` milestone.
243
+ The description should include the instruction for meeseeksmachine to backport changes
244
+ with the ``v2.0-doc `` milestone to both the ``v2.0.x `` branch and the ``v2.0.0-doc `` branch::
241
245
242
- git branch v2.0.x
246
+ Documentation changes (.rst files and examples)
247
+
248
+ on-merge: backport to v2.0.x
249
+ on-merge: backport to v2.0.0-doc
250
+
251
+ Check all active milestones for consistency. Older doc milestones should also backport to
252
+ higher minor versions (e.g. ``v3.6-doc `` should backport to both ``v3.6.x `` and ``v3.7.x ``
253
+ if the ``v3.7.x `` branch exists)
243
254
244
255
On this branch un-comment the globs from :ref: `release_chkdocs `. And then ::
245
256
246
- git push DANGER v2.0.x
257
+ git push DANGER v2.1.x
258
+
259
+ If this is the last micro release anticipated (or otherwise are entering feature
260
+ freeze for the next minor release), create a release branch for the next minor
261
+ release ::
247
262
263
+ git switch main
264
+ git branch v2.1.x
248
265
249
266
.. _release_DOI :
250
267
@@ -259,14 +276,13 @@ automatically produce one once the tag is pushed). Add the DOI post-fix and vers
259
276
the dictionary in :file: `tools/cache_zenodo_svg.py ` and run the script.
260
277
261
278
This will download the new SVG to :file: `doc/_static/zenodo_cache/{ postfix } .svg ` and
262
- edit :file: `doc/citing.rst `. Commit the new SVG, the change to
263
- :file: `tools/cache_zenodo_svg.py `, and the changes to :file: `doc/citing.rst ` to the
264
- VER-doc branch and push to GitHub. ::
279
+ edit :file: `doc/users/project/ citing.rst `. Commit the new SVG, the change to
280
+ :file: `tools/cache_zenodo_svg.py `, and the changes to :file: `doc/users/project/ citing.rst `
281
+ to the VER-doc branch and push to GitHub. ::
265
282
266
283
git checkout v2.0.0-doc
267
284
$EDITOR tools/cache_zenodo_svg.py
268
285
python tools/cache_zenodo_svg.py
269
- $EDITOR doc/citing.html
270
286
git commit -a
271
287
git push DANGER v2.0.0-doc:v2.0.0-doc
272
288
0 commit comments