Document release process #7673

Dreamsorcerer · 2023-10-07T17:26:20Z

@webknjaz We really need to document this somewhere. Is this an acceptable place?

webknjaz · 2023-10-07T18:37:32Z

Best put it under docs/ and include somewhere via MyST.

Dreamsorcerer · 2023-10-07T18:40:18Z

Best put it under docs/ and include somewhere via MyST.

We don't really want it on the main website, right? It's only relevant to aiohttp-admins, so being accessible only in the codebase makes more sense to me.

webknjaz · 2023-10-07T22:34:50Z

Honestly, I've seen people having this in a separate docs section, somewhere close to the contributing guides so I typically prefer it. It's not something secret. We document how to add changelog fragments there too, which is kinda related.

webknjaz · 2023-10-07T22:36:16Z

I also know that some people dislike polluting the repo root with many files, which is sometimes a source of complaints..

docs/contributing-admins.rst

codecov · 2023-10-08T13:41:19Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (9af20ac) 97.36% compared to head (a69f206) 97.41%.
Report is 136 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #7673      +/-   ##
==========================================
+ Coverage   97.36%   97.41%   +0.04%     
==========================================
  Files         106      107       +1     
  Lines       31630    32263     +633     
  Branches     3619     3750     +131     
==========================================
+ Hits        30797    31428     +631     
- Misses        630      632       +2     
  Partials      203      203

Flag	Coverage Δ
CI-GHA	`97.32% <ø> (+0.04%)`	⬆️
OS-Linux	`96.99% <ø> (+0.04%)`	⬆️
OS-Windows	`95.49% <ø> (+0.06%)`	⬆️
OS-macOS	`96.80% <ø> (+0.18%)`	⬆️
Py-3.10.11	`95.41% <ø> (+0.05%)`	⬆️
Py-3.10.13	`96.80% <ø> (-0.02%)`	⬇️
Py-3.11.5	`?`
Py-3.11.6	`96.53% <ø> (?)`
Py-3.12.0	`96.60% <ø> (?)`
Py-3.8.10	`95.38% <ø> (+0.05%)`	⬆️
Py-3.8.18	`96.73% <ø> (-0.02%)`	⬇️
Py-3.9.13	`95.38% <ø> (+0.06%)`	⬆️
Py-3.9.18	`96.77% <ø> (-0.01%)`	⬇️
Py-pypy7.3.11	`?`
Py-pypy7.3.13	`96.23% <ø> (?)`
VM-macos	`96.80% <ø> (+0.18%)`	⬆️
VM-ubuntu	`96.99% <ø> (+0.04%)`	⬆️
VM-windows	`95.49% <ø> (+0.06%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

webknjaz · 2023-10-10T16:24:52Z

docs/contributing-admins.rst

+:orphan:
+


Can we include this into the ToC instead of orphaning? Doesn't linking it from the other document not make this automatically?

Suggested change

:orphan:

For inspiration, there's some release sections in public docs:

https://pip.pypa.io/en/stable/development/release-process/#id5 / https://setuptools.pypa.io/en/latest/development/releases.html#release-process / https://ansible-pylibssh.readthedocs.io/en/latest/contributing/release_guide/#release-guide / https://scikit-hep.org/pyhf/development.html#publishing / https://devguide.python.org/developer-workflow/development-cycle/

Apparently, the meaning of orphan is just that it is not included it a toctree, not that it is undiscoverable (something which is confusing, as most users expect orphan to mean the latter)...

I'm not really sure we want to include it in a toctree? The sidebar has a link directly to contributing, I'm not sure it makes sense to include another link from the sidebar for something almost nobody needs to see. And I don't really see any other toctrees to use.

@Dreamsorcerer in other projects, I started making it a separate TOC, see:

https://ansible-pylibssh.readthedocs.io/en/latest/contributing/release_guide/

https://cheroot.cherrypy.dev/en/latest/devguide/

https://yarl.aio-libs.org/en/latest/contributing/release_guide/

I'd like to implement a similar structure here, eventually.

webknjaz · 2023-10-10T16:25:22Z

docs/contributing-admins.rst

+
+#. Start on the branch for the release you are planning (e.g. ``3.8`` for v3.8.6): ``git checkout 3.8 && git pull``
+#. Update the version number in ``__init__.py``.
+#. Run ``towncrier``.


I didn't use any. Do you have any arguments when you run it? I was just guessing.

@Dreamsorcerer I think I was testing with --draft and always passing --version. Though, I suppose Towncrier has some ability to import the version from a Python module. That doesn't always work, not for C-extension based codebases, anyway.

Right, I was wondering where it kept getting the version from. I just corrected it in the file manually.

docs/contributing-admins.rst

webknjaz

@Dreamsorcerer I left some notes. They are not mandatory and can be fixed in follow-ups. That's up to you.

Dreamsorcerer · 2023-11-23T13:15:50Z

@webknjaz Would it be fine to delete some of the oldest 3.x branches? Not sure if there's a reason they've been kept around, but they just seem so old now that they are not useful, and it's a bit of a nuisance that I now have to scroll to select the correct branch in a backport PR (all upto 3.8 are selectable without scrolling).

patchback · 2023-11-26T15:36:30Z

Backport to 3.9: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.9/aa7d1a8fcad4ac4f1f0eae577f4c1947ebc1acf3/pr-7673

Backported as #7909

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

(cherry picked from commit aa7d1a8)

patchback · 2023-11-26T15:36:37Z

Backport to 3.10: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.10/aa7d1a8fcad4ac4f1f0eae577f4c1947ebc1acf3/pr-7673

Backported as #7910

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

(cherry picked from commit aa7d1a8)

**This is a backport of PR #7673 as merged into master (aa7d1a8).** Co-authored-by: Sam Bull <git@sambull.org>

webknjaz · 2023-11-28T04:09:22Z

@webknjaz Would it be fine to delete some of the oldest 3.x branches? Not sure if there's a reason they've been kept around, but they just seem so old now that they are not useful, and it's a bit of a nuisance that I now have to scroll to select the correct branch in a backport PR (all upto 3.8 are selectable without scrolling).

@Dreamsorcerer I think it's fine for as long as there are tags on the tops of those branches.

webknjaz · 2023-11-28T04:13:03Z

docs/contributing-admins.rst

@@ -0,0 +1,57 @@
+:orphan:


@Dreamsorcerer also, since you put a link to this doc from another doc, Sphinx won't consider it orphan anymore. So it's not really needed either way.

I mentioned above, that's not what orphan means to Sphinx. It literally just means that it is not in a toctree, not that it is unreachable. So, it is needed in its current state.

Create RELEASE_PROCESS.md

a0d5109

Dreamsorcerer requested review from webknjaz and asvetlov as code owners October 7, 2023 17:26

Dreamsorcerer added the bot:chronographer:skip This PR does not need to include a change note label Oct 7, 2023

Dreamsorcerer added 4 commits October 8, 2023 13:39

Update contributing.rst

130f699

Update and rename RELEASE_PROCESS.md to docs/contributing-admins.rst

a855064

Update contributing-admins.rst

f303a85

Update contributing.rst

bd2227f

Dreamsorcerer changed the title ~~Create RELEASE_PROCESS.md~~ Document release process Oct 8, 2023

Dreamsorcerer added 4 commits October 8, 2023 14:05

Update contributing.rst

9e8730d

Update contributing-admins.rst

127e864

Update contributing-admins.rst

e227e7e

Update contributing-admins.rst

c3d7c29

Dreamsorcerer commented Oct 8, 2023

View reviewed changes

docs/contributing-admins.rst Outdated Show resolved Hide resolved

webknjaz reviewed Oct 10, 2023

View reviewed changes

docs/contributing-admins.rst Show resolved Hide resolved

webknjaz reviewed Oct 10, 2023

View reviewed changes

docs/contributing-admins.rst Outdated Show resolved Hide resolved

webknjaz approved these changes Oct 10, 2023

View reviewed changes

Update contributing-admins.rst

8b8e999

Dreamsorcerer added 4 commits November 23, 2023 13:17

Update contributing-admins.rst

037c9a1

Update contributing-admins.rst

7060637

Update spelling_wordlist.txt

96bf205

Add step for bumping dependabot.yml

1d5b1e6

Update spelling_wordlist.txt

a69f206

Dreamsorcerer added backport-3.9 Trigger automatic backporting to the 3.9 release branch by Patchback robot backport-3.10 Trigger automatic backporting to the 3.10 release branch by Patchback robot labels Nov 26, 2023

Dreamsorcerer merged commit aa7d1a8 into master Nov 26, 2023
32 of 34 checks passed

Dreamsorcerer deleted the Dreamsorcerer-patch-5 branch November 26, 2023 15:36

patchback bot pushed a commit that referenced this pull request Nov 26, 2023

Document release process (#7673)

4ca0a97

(cherry picked from commit aa7d1a8)

patchback bot mentioned this pull request Nov 26, 2023

[PR #7673/aa7d1a8f backport][3.9] Document release process #7909

Merged

patchback bot pushed a commit that referenced this pull request Nov 26, 2023

Document release process (#7673)

b8e00e1

(cherry picked from commit aa7d1a8)

patchback bot mentioned this pull request Nov 26, 2023

[PR #7673/aa7d1a8f backport][3.10] Document release process #7910

Merged

Dreamsorcerer added a commit that referenced this pull request Nov 26, 2023

[PR #7673/aa7d1a8f backport][3.9] Document release process (#7909)

9dbd273

**This is a backport of PR #7673 as merged into master (aa7d1a8).** Co-authored-by: Sam Bull <git@sambull.org>

Dreamsorcerer added a commit that referenced this pull request Nov 26, 2023

[PR #7673/aa7d1a8f backport][3.10] Document release process (#7910)

aa7b121

**This is a backport of PR #7673 as merged into master (aa7d1a8).** Co-authored-by: Sam Bull <git@sambull.org>

webknjaz reviewed Nov 28, 2023

View reviewed changes

xiangxli pushed a commit to xiangxli/aiohttp that referenced this pull request Dec 4, 2023

Document release process (aio-libs#7673)

a43ab19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document release process #7673

Document release process #7673

Dreamsorcerer commented Oct 7, 2023

webknjaz commented Oct 7, 2023

Dreamsorcerer commented Oct 7, 2023

webknjaz commented Oct 7, 2023

webknjaz commented Oct 7, 2023

codecov bot commented Oct 8, 2023 •

edited

Loading

webknjaz Oct 10, 2023

Dreamsorcerer Oct 11, 2023

webknjaz Nov 28, 2023

webknjaz Oct 10, 2023

Dreamsorcerer Oct 11, 2023 •

edited

Loading

webknjaz Nov 28, 2023

Dreamsorcerer Nov 29, 2023

webknjaz left a comment

Dreamsorcerer commented Nov 23, 2023

patchback bot commented Nov 26, 2023 •

edited

Loading

patchback bot commented Nov 26, 2023 •

edited

Loading

webknjaz commented Nov 28, 2023

webknjaz Nov 28, 2023

Dreamsorcerer Nov 29, 2023

Document release process #7673

Document release process #7673

Conversation

Dreamsorcerer commented Oct 7, 2023

webknjaz commented Oct 7, 2023

Dreamsorcerer commented Oct 7, 2023

webknjaz commented Oct 7, 2023

webknjaz commented Oct 7, 2023

codecov bot commented Oct 8, 2023 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Dreamsorcerer Oct 11, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

webknjaz left a comment

Choose a reason for hiding this comment

Dreamsorcerer commented Nov 23, 2023

patchback bot commented Nov 26, 2023 • edited Loading

Backport to 3.9: 💚 backport PR created

patchback bot commented Nov 26, 2023 • edited Loading

Backport to 3.10: 💚 backport PR created

webknjaz commented Nov 28, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Oct 8, 2023 •

edited

Loading

Dreamsorcerer Oct 11, 2023 •

edited

Loading

patchback bot commented Nov 26, 2023 •

edited

Loading

patchback bot commented Nov 26, 2023 •

edited

Loading