add release to project configuration

[mosc9575]

In this PR the missing value for the release variable is added to the conf.py. This sets DOCUMENTATION_OPTIONS.VERSION and enables a version check by the pydata-sphinx-theme version banner.

This is the local result.

• issues: fixes Version banner warns about unknown version on latest docs after 3.4.2 release #13948

To fix the version banner for https://docs.bokeh.org/en/latest/index.html no new release process is needed. It is enough to update the VERSION to '2.4.2' in https://docs.bokeh.org/en/latest/_static/documentation_options.js?v=5929fcd5.

The version banner can inform about the development version for https://docs.bokeh.org/en/dev-3.5/index.html with an update of https://docs.bokeh.org/en/dev-3.5/_static/documentation_options.js?v=5929fcd5 of VERSION to '3.5.0'
or '3.5.0.rc1'.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.10%. Comparing base (e61219b) to head (9b4ca85).
Report is 79 commits behind head on branch-3.5.

Additional details and impacted files

@@              Coverage Diff               @@
##           branch-3.5   #13949      +/-   ##
==============================================
+ Coverage       91.57%   93.10%   +1.52%     
==============================================
  Files             326      280      -46     
  Lines           20737    19799     -938     
==============================================
- Hits            18990    18433     -557     
+ Misses           1747     1366     -381     

[bryevdv]

I'd say this should get backported for good measure but I don't think this warrants a full point release. We'll need to build the docs manually with this change, then upload them to S3 and issue a cloudfront invalidation.

[mosc9575]

I'd say this should get backported for good measure but I don't think this warrants a full point release. We'll need to build the docs manually with this change, then upload them to S3 and issue a cloudfront invalidation.

Do you think it is necessary to do all this work? I agree there is some risk not to proceed with the normal process, but this will only change one small string. I think we cloud wait for the next 3.5.0-rc version. If this is not to far in the future, this will reduce the workload.

[bryevdv]

Backporting is trivial to do, but the currently deployed 3.4.2 docs will have the broken appearance forever if they are not re-uploaded, unless I am mistaken? If others don't care about this, though, I guess I'm happy to let it slide as well.

[mosc9575]

Is it possible to update only one file? To fix the current docs we only have to update and upload https://docs.bokeh.org/en/latest/_static/documentation_options.js?v=5929fcd5. Or is the v=5929fcd5 string a problem?

[bryevdv]

Oh, yes that is possible, I thought the data dict with the version was embedded on every page.

[bryevdv]

@mosc9575 (cc @tcmetzger) I have uploaded a new documentation_options.js to have VERSION: '3.4.2' and issued the invalidation. You can see the changes in the URL above (might need a force-reload to clear local cache). Unfortunately this does not seem to solve the issue. I also re-uploaded the switcher.json but that also did not help.

As an aside, the switcher used to have the both the "latest" entry, and the latest version number in the dropdown. If that is not possible then we need to have something like "3.4.2 (latest)" instead but I don't personally think that is ideal (I think both entries is ideal)

I am not sure how to proceed on the immediate fix, though,

[bryevdv]

@mosc9575 I do note that the "actual version" pages are fixed:

https://docs.bokeh.org/en/3.4.2/index.html

It's only the "latest" pages at /en/latest that have the broken banner. FWIW I did upload the fixed documentation_options.js in both locations.

[bryevdv]

@mosc9575 @tcmetzger actually scratch all that, I guess there was some delay / cache issue. Both versions seem to be fixed now. I do think the switcher needs tweaking, but that's a separate issue

[tcmetzger]

@bryevdv Thank you, I can confirm that this warning message is now gone from the devices I checked this on (Win11 / iOS)!

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.