sphinx-doc / sphinx

The Sphinx documentation generator
https://www.sphinx-doc.org/
Other
6.52k stars 2.12k forks source link

5.1.0 release plan #10657

Closed AA-Turner closed 2 years ago

AA-Turner commented 2 years ago

Roughly two months have passed since the 5.0.0 release. Based on our release cycle, I think we should release 5.1.0 soon.

Issues marked against 5.1.0: sphinx-doc/sphinx/milestone/126

@tk0miya I think it would be useful to have more co-maintainers who are able to do releases in case one of us is ill/on holiday/etc, so I am happy to volunteer to do this release -- would you be OK with this? I would need to be added to the PyPI project, my username is the same (AA-Turner).

A

AA-Turner commented 2 years ago

I would like to get #10656 in, does anybody have any other PRs for inclusion in 5.1?

A

jfbu commented 2 years ago

Are you planning on releasing 5.0.3 as well or will you simply merge its CHANGES entries into the 5.1.0's ones (as the patches are already merged into 5.x)?

I would like to merge #10648, and will now make a final re-examination of it. Merge of #10648 done.

tk0miya commented 2 years ago

I think it would be useful to have more co-maintainers who are able to do releases in case one of us is ill/on holiday/etc, so I am happy to volunteer to do this release -- would you be OK with this?

Of course, I'm okay to grant permission for the release to you. But, unfortunately, I don't have permission to invite a new maintainer in PyPI. @shimizukawa Could you check the list of maintainers, please?

BTW, could you append your GPG key to the end of README as preparation for the release? It's needed to verify the signature of released packages.

tk0miya commented 2 years ago

Are you planning on releasing 5.0.3 as well or will you simply merge its CHANGES entries into the 5.1.0's ones (as the patches are already merged into 5.x)?

If 5.0.3 will not be released, the these changes will be released as v5.1.0. So the entries should be moved to the section of 5.1.0 on the stable release.

shimizukawa commented 2 years ago

Of course, I'm okay to grant permission for the release to you. But, unfortunately, I don't have permission to invite a new maintainer in PyPI. @shimizukawa Could you check the list of maintainers, please?

@tk0miya oh, now your administrative privileges have been changed to owner ;)

AA-Turner commented 2 years ago

BTW, could you append your GPG key to the end of README as preparation for the release? It's needed to verify the signature of released packages.

Done!

A

tk0miya commented 2 years ago

@shimizukawa Thank you for quick work! confirmed.

@AA-Turner I just send invitations for sphinx and related packages. Could you check your mailbox, please?

AA-Turner commented 2 years ago

Thanks @tk0miya! I will plan to make the release this weekend (23-24 July). I will try and work on #10480. I may move #10286 to the next release depending on Jakob's view of the PR, as I'm not comfortable reviewing it myself.

A

AA-Turner commented 2 years ago

Sphinx 5.1.0 has been released! Thanks to all contributors for your support with this release.

A

marxin commented 2 years ago

Thanks for the release!

I've just noticed the release is not available from the location I'm used to: https://files.pythonhosted.org/packages/source/S/Sphinx/Sphinx-5.1.0.tar.gz

But I was able to download it here: https://files.pythonhosted.org/packages/b6/3e/cb066e5cb76302f73a20e302b40e6fd5aea9462ce520581165348c008913/Sphinx-5.1.0.tar.gz

but OBS for openSUSE it claims the GPG key is unknown:

$ cat Sphinx-5.1.0.tar.gz.asc
-----BEGIN PGP SIGNATURE-----

iQIzBAABCAAdFiEE01SRGb1RtK/mQ+WXUsj3KmHw+1IFAmLdQ9QACgkQUsj3KmHw
+1Ijkg/+N7+imFUQ1jgQs1yUgX/+uFVMTZD0zCwaEy64ot1Pw4KnWag1BH/tk2WK
NJfED8awWfcKIwl1nB4E2jI8bl4EAx3/luK3RWrIdTrUjSzMY6kejhdGbFHnov+o
Kb1kR3cdxZTiL7ha5n2wgwhlllFajC56eLDr6WynUXdgjkvmdS8yoEXIU7RzJYZw
yQVH9hl58Fj+CSVCZmWNwELnrAg4uQZbaazORVuFbzO02oBppMvIbLw3sWxYdlIp
WhUayvD3oKMeEdI811bfE5nhX5tuVQ2KFjVvri5KElPywtUoCVeG3fnAK0KNB82s
SmS044N8LFKSmbQqi1EaW6/zuiHkw3d8MzG/6CoumHlaBetaWXpH6jNUliX96Rg3
y6Jz0zkKLdIJ0lqzYbVpGxJTKlw+spWZJ2gVfjVla5lKiK8y5R/ObImQ6MVJGcBq
0QfJ4MLSPORRTmQINnofCwOWMOwxU2oS+iWe15+InlMCWCtwUw/2P26ZiaQeeisA
+khN8icVx1m+GRwgxMroQaFvvoYpSnBdUHvzPwksFgN09iI0ER/baS3gofIbq3XS
R/QKO6oRJyw56Q6Hz89Itq26CiuWP3ulf0FjXxdJ/FeuUcz3Qp+r3r6BtvYfcMrd
wQbdBitZJtz4gh7YYVd42KhkUxOLRSH9Ed/wrclMgFzDrjIzFHs=
=RUQm
-----END PGP SIGNATURE-----
$ md5sum Sphinx-5.1.0.tar.gz
d9ce8c27df0fa9b5213145bd9cd7c3d4  Sphinx-5.1.0.tar.gz
$ osc build
Building python-Sphinx.spec for openSUSE_Tumbleweed/x86_64
Run source service: /usr/lib/obs/service/format_spec_file --outdir /home/marxin/BIG/osc/home:marxin:branches:devel:languages:python/python-Sphinx/tmpye8a8_wa.format_spec_file.service
Run source service: /usr/lib/obs/service/source_validator --outdir /home/marxin/BIG/osc/home:marxin:branches:devel:languages:python/python-Sphinx/tmpxwjtixp_.source_validator.service
gpg: Signature made Sun 24 Jul 2022 03:06:28 PM CEST
gpg:                using RSA key D3549119BD51B4AFE643E59752C8F72A61F0FB52
gpg: Can't check signature: No public key
ERROR: signature /home/marxin/BIG/osc/home:marxin:branches:devel:languages:python/python-Sphinx/Sphinx-5.1.0.tar.gz.asc does not validate
Aborting: service call failed:  /usr/lib/obs/service/source_validator --outdir /home/marxin/BIG/osc/home:marxin:branches:devel:languages:python/python-Sphinx/tmpxwjtixp_.source_validator.service
Source service run failed!
marxin commented 2 years ago

but OBS for openSUSE it claims the GPG key is unknown:

Oh, we've got a keyring in the package: https://build.opensuse.org/package/view_file/devel:languages:python/python-Sphinx/python-Sphinx.keyring?expand=1

So I'll need to add your key there (0x52C8F72A61F0FB52), sorry for the noise.

AA-Turner commented 2 years ago

I've just noticed the release is not available from the location I'm used to: https://files.pythonhosted.org/packages/source/S/Sphinx/Sphinx-5.1.0.tar.gz

I ran twine upload as set out in the utils/release-checklist file -- I don't know what guarantees pythonhosted provides.

A

marxin commented 2 years ago

I've just noticed the release is not available from the location I'm used to: https://files.pythonhosted.org/packages/source/S/Sphinx/Sphinx-5.1.0.tar.gz

Note the following links work fine now, thanks!