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

Added note to bump stable branch docs config on release. #14248

Merged
merged 1 commit into from Apr 22, 2021
Merged

Added note to bump stable branch docs config on release. #14248

merged 1 commit into from Apr 22, 2021

Conversation

carltongibson
Copy link
Member

django_next_version in docs/conf.py should be bumped in stable branch on final
release.

Copy link
Member

@felixxm felixxm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@carltongibson Thanks 👍 I think we should move this note to the "Pre-release tasks", maybe up to the 7th point 🤔 .

@carltongibson
Copy link
Member Author

Hey @felixxm -- yes, i was pondering if it's a When creating the new stable branch task. Let's decide tomorrow. 😉

@timgraham
Copy link
Member

I think it's fine to do when creating a new stable branch. This controls whether the version number or "Development version" appears in the versionadded/changed annotations.

Actually, it might be feasible to remove this in favor of checking django.VERSION. If the last three parts of the tuple are (0, 'alpha', 0) then it's a pre-alpha development version. It's unclear under what conditions django.VERSION can't be imported though (added in 373df56).

django_next_version in docs/conf.py should be bumped when creating a new stable
branch.
@carltongibson
Copy link
Member Author

Hey Tim — thanks for looking — another lurker on my list 🤹‍♂️.

I've adjusted the comment to go at the creating new stable branch step (which is 9 currently).

...it might be feasible to remove this in favor of checking django.VERSION. ...

That would be better.

It's unclear under what conditions django.VERSION can't be imported though (added in 373df56).

Looking above I wonder how this could ever (excluding syntax errors and the like) fail now:

django/docs/conf.py

Lines 24 to 25 in 4a77aeb

# Make sure we get the version of this copy of Django
sys.path.insert(1, dirname(dirname(abspath(__file__))))

If that went wrong we'd want it to crash no? 🤔

I need to have a little dig around.

@carltongibson
Copy link
Member Author

Tim's https://code.djangoproject.com/ticket/21400#comment:6 — reloading Django on the build server to get the right version. Grrr.

I think merge this for now, and see if there's an adjustment as time/bandwidth/motivation permits.

Thanks both!

@carltongibson carltongibson merged commit 6a7af38 into django:main Apr 22, 2021
@carltongibson carltongibson deleted the c/add-next-version-note branch April 22, 2021 07:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants