Skip to content
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

Release 0.16.0 #1948

Open
5 of 10 tasks
Carreau opened this issue Aug 7, 2024 · 21 comments
Open
5 of 10 tasks

Release 0.16.0 #1948

Carreau opened this issue Aug 7, 2024 · 21 comments
Labels
kind: release Items related to PST releases

Comments

@Carreau
Copy link
Collaborator

Carreau commented Aug 7, 2024

I think with the recent sphinx 8 fixes it woudl be good to make a new release potentially dropping older shinx. Here are the list of things to do for a new release.

Double check for quality-control

Prepare the codebase for a new version

  • Bump __version__ in __init__.py
  • Update our version switcher .json file with the new version
  • Make a release commit: git commit -m 'bump: 0.1.9 → 0.2.0'
  • Push the RLS commit git push upstream main
  • If a release candidate is needed, tick this box when we're now ready for a full release.

Make the release

  • Start a new GitHub release
    • Call the release the current version, e.g. v0.2.0
    • In the Choose a Tag: dropdown, type in the release name (e.g., v0.2.0) and click "Create new tag"
    • In the Target: dropdown, pin it to the release commit that you've just pushed.
    • Generate the automatic release notes, eventually manually specify the previous version (useful when several release candidate have been made)
  • Confirm that the release completed
  • Hide the previous patch version build in the RDT interface if needed.
  • Celebrate, you're done!
@Elodie-Praxinos
Copy link

Just to say I'd really like a version compatible with Sphinx 8 too!

@Carreau
Copy link
Collaborator Author

Carreau commented Aug 8, 2024

I don't think it's incompatible, did you encounter any specific errors ?

@Elodie-Praxinos
Copy link

Yes:

ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts. myst-parser 0.17.0 requires docutils<0.18,>=0.15, but you have docutils 0.21.2 which is incompatible. myst-parser 0.17.0 requires sphinx<5,>=3.1, but you have sphinx 8.0.2 which is incompatible.

@drammock
Copy link
Collaborator

drammock commented Aug 8, 2024

Please try updating myst parser. Current stable release is 4.0.0 and you seem to have 0.17.0

@Elodie-Praxinos
Copy link

Indeed, that helped. Now I got other issues probably coming from the fact I am already using a different theme (sphinx-material).

pickling environment... WARNING: cannot cache unpickable configuration value: 'html_context' (because it contains a function, class, or module object) [config.cache]
done
checking consistency... done
preparing documents... done
copying assets... 
copying static files... done
copying extra files... done
copying assets: done
writing output... [  1%] 
Extension error (pydata_sphinx_theme):
Handler <function update_and_remove_templates at 0x1131fce50> for event 'html-page-context' threw an exception (exception: 'logo-text.html' not found in ['/Users/elodie/Documents/github/Doc/source/_templates', '/Users/elodie/Library/Python/3.10/lib/python/site-packages/pydata_sphinx_theme/theme/pydata_sphinx_theme/components', '/Users/elodie/Library/Python/3.10/lib/python/site-packages/pydata_sphinx_theme/theme/pydata_sphinx_theme', '/Users/elodie/Library/Python/3.10/lib/python/site-packages/sphinx/themes/basic'])

@trallard trallard added the kind: release Items related to PST releases label Aug 16, 2024
@dylanh724
Copy link

Related: #1938

@dopplershift
Copy link

MetPy's docs are building fine with sphinx 8.0.2 and pydata-sphinx-theme 0.15.4 (myst-parser 4.0.0).

@dbitouze
Copy link
Contributor

dbitouze commented Sep 5, 2024

MetPy's docs are building fine with sphinx 8.0.2 and pydata-sphinx-theme 0.15.4 (myst-parser 4.0.0).

The same applies to the French LaTeX FAQ 😊

@drammock
Copy link
Collaborator

@trallard @Carreau seems like we're close to being ready for another release? Only listed blockers are #1982 (which looks to be basically done?) and #1938 (which I think can be closed as completed given the comments above). #1992 made me realize some nice improvements still aren't in the hands of stable users.

@trallard
Copy link
Collaborator

We should be able to make a release whenever (#1982 is now merged), and we have been testing against Sphinx 8, and I have not spotted anything amiss. Neither of our CIs has so it is up to you @drammock, shall we cut a pre-release?

@drammock
Copy link
Collaborator

shall we cut a pre-release?

Yes I think so. I probably can't do it until next Wednesday so if one of you has time sooner then go for it

@trallard
Copy link
Collaborator

I shall be able to do this on Monday.

@trallard trallard changed the title Release 0.15.5 (0.16?) Release 0.16.0 Sep 30, 2024
@trallard trallard pinned this issue Sep 30, 2024
@trallard
Copy link
Collaborator

The pre-release is now out https://pypi.org/project/pydata-sphinx-theme/0.16.0rc0/
This can be installed with pip install pydata-sphinx-theme==0.16.0rc0 --pre

There is also a discussion opened #1997

@trallard
Copy link
Collaborator

There do not seem to be any major issues identified through the release candidate, and the few bugs raised have been addressed.
So will target to make a full release early this week 🚀

@dbitouze
Copy link
Contributor

@12rambau and @Carreau There's still time to adjust the French translation (#2010), isn't it?

@melissawm
Copy link
Contributor

When building the NumPy docs I noticed an issue with the search navbar-item:

Captura de imagem_20241014_151241

I am not sure if that comes from the theme or one of our customizations but will check.

SciPy looks good as far as I can tell 👍🏻

@drammock
Copy link
Collaborator

@trallard what about #2007 ? It's minor enough that I didn't label as a release blocker, but by the same token it's minor enough that I'd be comfortable rolling it in as a bugfix between RC and release (if you or @gabalafou look and don't notice anything amiss, that is)

@dbitouze
Copy link
Contributor

@melissawm

When building the NumPy docs I noticed an issue with the search navbar-item:

Already reported and fixed 😉

@trallard
Copy link
Collaborator

@drammock, I think it is okay to include #2007. It is a bug (I just checked the Figma file, and the hover colour change went missing somehow), but it is small enough that I do not expect it to cause any issues. I did leave a comment on the tests, though.

@dbitouze I can definitely get the translations in.

@dbitouze
Copy link
Contributor

@dbitouze I can definitely get the translations in.

Sorry, I don't see what you mean.

@trallard
Copy link
Collaborator

Sorry if I was not clear enough @dbitouze. I meant that if the French translations are updated I should be able to include them in the proper release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: release Items related to PST releases
Projects
None yet
Development

No branches or pull requests

8 participants