-
-
Notifications
You must be signed in to change notification settings - Fork 7.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update release guide instructions post v3.7.0 #25235
Conversation
doc/devel/release_guide.rst
Outdated
If this is the last micro release anticipated (or otherwise are entering feature | ||
freeze for the next minor release), create a release branch for the next minor | ||
release :: | ||
|
||
git switch main | ||
git branch v2.1.x |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not normally something we do. Everything goes to main
until we decide to branch near-ish the release candidate. It's not related to the tagging of the last bugfix/micro.
Branching and tagging a final micro release are independent. I chose to tag 3.6.3 at the time of making v3.7.x, because there just seemed to be enough already backported to make a release. But there is no correlation between these two steps.
We have conditions in the reST to automatically enable/disable these sections. Those instructions are outdated and can be deleted.
It should occur for every release, though it's not always done. Ensuring that the version, as generated by |
RE sequencing and severing the idea of creating the release branch and doing the release:
RE Next what's new:
RE merge-up:
(for this cycle, there was one set of changes fixing grammar on a note added to each animation tutorial that was made only in the v3.7.x branch, but other than that and the link fixes during release used |
I think we have historically had a final micro around the time we did the next minor/major release? That said, my impressions of this may be very clouded by the 2.0 and 3.0 processes which both had very long running (N-1).x.y series associated with them.... |
For example, 3.5.3 was tagged on Aug 10, but the first backport that got to v3.6.x was Aug 22 and 3.6.0rc1 was Aug 22. I don't recall exactly when that branching happened, but it wasn't at the same time as the 3.5.3 release. |
Updating pinned versions of mpl-sphinx-theme added via matplotlib/mpl-sphinx-theme#57 rather than here. |
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just two minor tweaks.
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
PR Summary
TODOS
Discuss wording/sequencing of creating the release branches/milestones
- I have a relatively minimal change that puts "create the release branch" in the same part of the workflow, just instead of releasing from main and then creating the release branch during the
.0
release, we create it for the last anticipated micro release of the previous minor version. This is closer, I think to what we actually do, but not sure if we want to reorganize that thought.Add comment out of
Next what's new
to the appropriate section- This is referred to later on to uncomment, but it doesn't actually say to comment it in the linked section.
- Alternatively, may be able to use rst to ignore it for releases and not have to edit this at all.
When and how does the "merge-up" process work? (See Merge v3.6.x branch to main #23918 for an example of such a pull request)
- Does this only happen for
.0
releases, or every release- If conflicts do arise, how are they resolved (can a standard answer be given?)?
- Is the only real need for this for the purposes of the version switcher? (which seems to be the primary stated reason)
- Document interactions with setuptools-scm (which is the other stated reason)
PR Checklist
Documentation and Tests
pytest
passes)Release Notes
.. versionadded::
directive in the docstring and documented indoc/users/next_whats_new/
.. versionchanged::
directive in the docstring and documented indoc/api/next_api_changes/
next_whats_new/README.rst
ornext_api_changes/README.rst