@@ -29,13 +29,13 @@ Add/drop Python versions
2929When adding or dropping Python versions, three files need to be edited:
3030
3131- .github/workflows/wheels.yml # for github cibuildwheel
32- - .travis. yml # for cibuildwheel aarch64 builds
33- - setup.py # for classifier and minimum version check.
32+ - tools/ci/cirrus_wheels. yml # for cibuildwheel aarch64/arm64 builds
33+ - pyproject.toml # for classifier and minimum version check.
3434
3535Make these changes in an ordinary PR against main and backport if necessary.
36- Using the ` BLD: ` prefix (build label) for the commit summary will cause the
37- wheel builds to be run so that the changes will be tested, We currently release
38- wheels for new Python versions after the first Python rc once manylinux and
36+ Add `` [wheel build] `` at the end of the title line of the commit summary so
37+ that wheel builds will be run to test the changes. We currently release wheels
38+ for new Python versions after the first Python rc once manylinux and
3939cibuildwheel support it. For Python 3.11 we were able to release within a week
4040of the rc1 announcement.
4141
@@ -50,7 +50,7 @@ Update 2.1.0 milestones
5050-----------------------
5151
5252Look at the issues/prs with 2.1.0 milestones and either push them off to a
53- later version, or maybe remove the milestone.
53+ later version, or maybe remove the milestone. You may need to add a milestone.
5454
5555
5656Make a release PR
@@ -59,7 +59,7 @@ Make a release PR
5959Four documents usually need to be updated or created for the release PR:
6060
6161- The changelog
62- - The release- notes
62+ - The release notes
6363- The ``.mailmap `` file
6464- The ``pyproject.toml `` file
6565
@@ -115,20 +115,18 @@ Finish the release notes
115115------------------------
116116
117117If there are any release notes snippets in ``doc/release/upcoming_changes/ ``,
118- run ``towncrier ``, which will incorporate the snippets into the
119- ``doc/source/release/notes-towncrier.rst `` file, add it to the index, and
120- delete the snippets::
118+ run ``spin notes ``, which will incorporate the snippets into the
119+ ``doc/source/release/notes-towncrier.rst `` file and delete the snippets::
121120
122- $ towncrier
121+ $ spin notes
123122 $ gvim doc/source/release/notes-towncrier.rst doc/source/release/2.1.0-notes.rst
124123
125- Once the ``notes-towncrier `` contents has been incorporated into
126- the release note it should be cleared and the
127- ``.. include:: notes-towncrier.rst `` directive removed from the ``2.1.0-notes.rst ``.
128- The notes will always need some fixups, the introduction will need to be
129- written, and significant changes should be called out. For patch releases the
130- changelog text may also be appended, but not for the initial release as it is
131- too long. Check previous release notes to see how this is done.
124+ Once the ``notes-towncrier `` contents has been incorporated into release note
125+ the ``.. include:: notes-towncrier.rst `` directive can be removed. The notes
126+ will always need some fixups, the introduction will need to be written, and
127+ significant changes should be called out. For patch releases the changelog text
128+ may also be appended, but not for the initial release as it is too long. Check
129+ previous release notes to see how this is done.
132130
133131
134132Release walkthrough
@@ -309,6 +307,7 @@ Once everything seems satisfactory, update, commit and upload the changes::
309307Create release notes for next release and edit them to set the version. These
310308notes will be a skeleton and have little content::
311309
310+ $ git checkout -b begin-2.1.1 maintenance/2.1.x
312311 $ cp doc/source/release/template.rst doc/source/release/2.1.1-notes.rst
313312 $ gvim doc/source/release/2.1.1-notes.rst
314313 $ git add doc/source/release/2.1.1-notes.rst
@@ -324,7 +323,7 @@ Update the ``version`` in ``pyproject.toml``::
324323
325324Commit the result::
326325
327- $ git commit -a -m"MAINT: prepare 2.1.x for further development"
326+ $ git commit -a -m"MAINT: Prepare 2.1.x for further development"
328327 $ git push origin HEAD
329328
330329Go to GitHub and make a PR. It should be merged quickly.
@@ -367,9 +366,10 @@ BCC so that replies will not be sent to that list.
36736611. Post-release update main (skip for prereleases)
368367---------------------------------------------------
369368
370- Checkout main and forward port the documentation changes::
369+ Checkout main and forward port the documentation changes. You may also want
370+ to update these notes if procedures have changed or improved::
371371
372- $ git checkout -b post-2.1.0-release-update
372+ $ git checkout -b post-2.1.0-release-update main
373373 $ git checkout maintenance/2.1.x doc/source/release/2.1.0-notes.rst
374374 $ git checkout maintenance/2.1.x doc/changelog/2.1.0-changelog.rst
375375 $ git checkout maintenance/2.1.x .mailmap # only if updated for release.
@@ -380,13 +380,3 @@ Checkout main and forward port the documentation changes::
380380
381381Go to GitHub and make a PR.
382382
383-
384- 12. Update oldest-supported-numpy
385- ---------------------------------
386-
387- If this release is the first one to support a new Python version, or the first
388- to provide wheels for a new platform or PyPy version, the version pinnings
389- in https://github.com/scipy/oldest-supported-numpy should be updated.
390- Either submit a PR with changes to ``setup.cfg `` there, or open an issue with
391- info on needed changes.
392-
0 commit comments