5.0.0 release plan

[tk0miya]

According to our annual release cycle, the end of May will be time for the major release.
I just make a schedule for the release. What do you think?

• Next weekend (Apr 2nd or 3rd)
  • Create a new branch: 5.x
    • A development branch for 5.0.0
• Apr 30th or May 1st:
  • Beta release (feature freeze)
  • call for translation
  • Create a new branch: 5.0.x
    • 5.x will be used for develop 5.1
    • 5.0.x will be used for develop 5.0.0 (feature freezed)
• May 28th or 29th:
  • Final release

Note: issues marked as 5.0.0: https://github.com/sphinx-doc/sphinx/milestone/105

I think the "5.0.0" milestone contains many issues and PRs that will be planned to fix during 5.x series. So it would be better to rename it to "5.x" and to make a brandnew milestone for "5.0.0".

[shimizukawa]

Thanks for the planning. No objection from me.

[tk0miya]

Create a new branch: 5.x
A development branch for 5.0.0

I just created 5.x branch: https://github.com/sphinx-doc/sphinx/tree/5.x
Now, it's the default branch of this repo.

[tk0miya]

Apr 30th or May 1st:

Oops... I missed my proposal. I'll work on this tomorrow.

[AA-Turner]

@tk0miya please can we merge #10164 for 5.0? There seemed to be consensus on the linked issue that it was the best course of action.

A

[tk0miya]

Sorry, I need a few days to freeze features. So I determined to postpone the feature freeze to this weekend.

Luckily, I have holidays this mid-week. So I'll work hard until the freeze.

[tk0miya]

I resolved my concerns now. So it's time to feature freeze. What do you think, maintainers?

I'll ship a beta package within 24 hours if you don't have worries. Please let me know if you still working on some issues and PRs.

[AA-Turner]

if you still working on some issues and PRs.

I'm not working on anything that needs to go into 5.0 at the moment -- thanks!

A

[jfbu]

I wish to merge #10365 I hope there is still time ; will take care of this in the next few minutes

[jfbu]

Done for merge of #10365. I don't have anything on the works for now, go ahead !

(I wished I had handled long standing #8686 but this is too extensive work for the available time I have had last few months).

[tk0miya]

From now on, I start to ship 5.0.0b1.

• Beta release (feature freeze)
• call for translation
• Create a new branch: 5.0.x
  • 5.x will be used for develop 5.1
  • 5.0.x will be used for develop 5.0.0 (feature freezed)

[tk0miya]

Released: https://pypi.org/project/Sphinx/5.0.0b1/.

Let's see the bug reports for the beta release and fix them as possible.

Thank you all for your great work :-)

[tk0miya]

May 28th or 29th:
Final release

Sorry for not responding so long. Originally, this weekend is the release date. It seems #10463 and #10415 are blocker issues for the release. So I'll check them tomorrow.
Do you have any worries or remaining tasks for the release? Please let me know.

Thanks,

[jfbu]

Do you have any worries or remaining tasks for the release? Please let me know.

no worries or remaining tasks on my side!

[AA-Turner]

Nothing from me beyond #10463 and #10481! Thanks!

A

[tk0miya]

It's my bad. I also meant #10463 and #10481 (merged just now). So I'll take a look #10463 from now on.

[tk0miya]

I'm going to release a new package from now on.

[tk0miya]

Released. https://pypi.org/project/Sphinx/5.0.0/

I must appreciate all your help!

[AiyionPrime]

Congratulations to the new release.
@tk0miya would you mind tagging it as the current version here on GitHub? Or at least a tag in git?

Might help @polyzen to get out the new release on arch :)

[jmckenna]

Congratulations to the new release. @tk0miya would you mind tagging it as the current version here on GitHub? Or at least a tag in git?

this was supposed to be automated, through #9842 (the tag exists, but the release did not auto-happen)

[AA-Turner]

@hugovk -- do you know how we can debug this? The tag that was pushed matches the pattern in the workflow, it seems.

A

[hugovk]

Hmm, I'm not too sure. The workflow didn't trigger at all:

https://github.com/sphinx-doc/sphinx/actions/workflows/create-release.yml

I created a test 5.0.1 tags on my fork with git tag v5.0.1 and pushed with git push --tags (also a 5.0.2) and the workflow triggered:

https://github.com/hugovk/sphinx/actions/workflows/create-release.yml

And created releases:

https://github.com/hugovk/sphinx/releases

The workflow trigger is:

on:
  push:
    tags:
    - "v*.*.*"

The tags match the pattern, but I wonder why it didn't get triggered? I wonder, was the tag created in another way?

[AiyionPrime]

Two things come to mind:
The tag could have been created on GitHub, and technically not have been pushed?
on: push:

The other is the deviation from semver you are doing here.
If one sorted your releases naively, 5.0.0b1 would be after 5.0.0.

>>> sorted(['5.0.0', '4.5.0', '5.0.0b1'])
['4.5.0', '5.0.0', '5.0.0b1']

Semver wants not only major-, minor- also the patchversion to increment from release to release.

The only two "exceptions" for Patchversions (maj.min.pat) are buildmetadata starting with a + and prereleases starting with a -.

Depending on how GitHub(/-actions) works on semver, it could be that it searched for the + and - could not find either and made 0b1 the latest minor version.

Could be the actions bot is simply not announcing releases automatically, that are "older".

[hugovk]

v*.*.* is a glob pattern, it doesn't care about semver.

https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#onpushbranchestagsbranches-ignoretags-ignore

https://www.digitalocean.com/community/tools/glob?comments=true&glob=v%2A.%2A.%2A&matches=false&tests=v4.5.0&tests=v5.0.0b1&tests=v5.0.0&tests=v5.0.0&tests=5.0.0&tests=v5.0

[pradyunsg]

The trigger is fine, lets assume it fired.

But it did not fire, as @hugovk has noted already.

https://github.com/sphinx-doc/sphinx/actions/workflows/create-release.yml

[hugovk]

I don't think it did fire, we don't see a workflow run here:

https://github.com/sphinx-doc/sphinx/actions/workflows/create-release.yml

If it did, we would have some logs to see what the actions in the workflow did (or did not do). We would at least see the actions/checkout step before even getting to softprops/action-gh-release.

https://github.com/sphinx-doc/sphinx/blob/5.x/.github/workflows/create-release.yml

[AiyionPrime]

I'm sorry @hugovk, I did not read that line properly the first time around.