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

Version-lock unlocked dependencies #1759

Merged
merged 1 commit into from
Mar 9, 2015

Conversation

bitprophet
Copy link
Contributor

As the author of one of the new theme dependencies (alabaster), having a wholly unqualified requirement scared me a bit re: ability to make non-bugfix releases without downstream users' sites changing underneath them in unexpected (visual) ways (without them consciously upgrading Sphinx versions).

alabaster uses semantic versioning so the lock reflects this.

For consistency, I updated the other new theme dependency similarly, and made babel match its fellow non-theme dependencies in having an optimistic (vs semantic) version lock, but I can revert these changes if desired.

As the author of one of the new theme dependencies (`alabaster`), having a wholly unqualified requirement scared me a bit re: ability to make non-bugfix releases without downstream users' sites changing underneath them in unexpected (visual) ways without them consciously upgrading Sphinx versions.

`alabaster` uses semantic versioning so the lock reflects this.

For consistency, I also updated the other new theme dependency similarly, and made `babel` match its fellow non-theme dependencies in having an optimistic (vs semantic) version lock, but I can revert these changes if desired.
@bitprophet
Copy link
Contributor Author

I should probably /cc @ericholscher since he manages PyPI for the other new theme :)

@birkenfeld
Copy link
Member

+1

1 similar comment
@shimizukawa
Copy link
Member

+1

'sphinx_rtd_theme',
'babel>=1.3',
'alabaster>=0.7,<0.8',
'sphinx_rtd_theme>=0.1,<0.2',
Copy link
Member

Choose a reason for hiding this comment

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

@ericholscher do you have a plan to release a new sphinx_rtd_theme in a day? Or do you have any opinion for about the version range 'sphinx_rtd_theme>=0.1,<0.2'?

@shimizukawa shimizukawa added this to the 1.3 milestone Mar 8, 2015
@shimizukawa shimizukawa self-assigned this Mar 8, 2015
@ericholscher
Copy link
Contributor

That range sounds good. The theme is waiting on some work with the sass tooling. We can ship a new version next week, but no reason to wait for a release on it.

@shimizukawa
Copy link
Member

@ericholscher Thanks!

shimizukawa added a commit that referenced this pull request Mar 9, 2015
Version-lock unlocked dependencies
@shimizukawa shimizukawa merged commit b557b56 into sphinx-doc:master Mar 9, 2015
@bitprophet
Copy link
Contributor Author

Thanks all

@ericholscher
Copy link
Contributor

Just pushed a 0.1.7 release of our theme, btw. Should be up to date with GH
now.

On Mon, Mar 9, 2015 at 1:02 PM, Jeff Forcier notifications@github.com
wrote:

Thanks all
https://camo.githubusercontent.com/d41e6b534530892a7c71a4b7520abda1cfa597cb/687474703a2f2f692e736f6d657468696e67617766756c2e636f6d2f666f72756d73797374656d2f656d6f7469636f6e732f656d6f742d746f6f742e676966


Reply to this email directly or view it on GitHub
#1759 (comment).

Eric Holscher
Maker of the internet residing in Portland, Or
http://ericholscher.com

@ericholscher
Copy link
Contributor

Actually I see that 1.3 has a breaking theme change (tt -> code) -- I guess the correct thing to do is make the theme support both? I was thinking about making a version number to 0.2 to support the 1.3 release. Not sure what makes the most sense, I think I'll go with supporting both.

@ericholscher
Copy link
Contributor

@bitprophet
Copy link
Contributor Author

Nice catch @ericholscher, I may need to make a related change in alabaster too (I see it styling tt+pre but not code). Let me know what you end up doing...

@shimizukawa
Copy link
Member

Ah.. if sphinx_rtd_theme (and alabaster) update major version soon, I'll also update sphinx's setup.py before releasing. For now,I suspend releasing process.

@ericholscher
Copy link
Contributor

We can probably support both at the same time, in the same version, so no
need to wait. Don't want to hold things up, just making a point that it
might be an issue. It does break the output of the RTD theme API stuff, but
I will fix it before deploying 1.3 on RTD, so it should be pretty minimal
impact.

On Mon, Mar 9, 2015 at 4:37 PM, Takayuki SHIMIZUKAWA <
notifications@github.com> wrote:

Ah.. if sphinx_rtd_theme (and alabaster) update major version soon, I'll
also update sphinx's setup.py before releasing. For now,I suspend releasing
process.


Reply to this email directly or view it on GitHub
#1759 (comment).

Eric Holscher
Maker of the internet residing in Portland, Or
http://ericholscher.com

@shimizukawa
Copy link
Member

@ericholscher I see. @bitprophet how about alabaster?

@shimizukawa
Copy link
Member

I'll release 1.3 late today (UTC).
If the themes has been updated, I will re-release the minor version.

@bitprophet
Copy link
Contributor Author

@shimizukawa I consider such a change in alabaster to be a bugfix, so it wouldn't affect the Sphinx setup.py (i.e. I'd release 0.7.2, not 0.8). Please go ahead as needed :)

@bitprophet
Copy link
Contributor Author

Just pushed 0.7.2 with the changes re: tt/code, tests ok with one of my projects' API doc pages on both Sphinx 1.2 and Sphinx 1.3. Woo \o/

@shimizukawa
Copy link
Member

@bitprophet Thanks! I resume the release process. 😀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 27, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants