search

readthedocs / sphinx_rtd_theme

Sphinx theme from Read the Docs
https://sphinx-rtd-theme.readthedocs.io/
MIT License
4.73k stars 1.73k forks source link

Switch to using bumpver #1324

Open agjohnson opened 2 years ago

agjohnson commented 2 years ago

We switched out bumpversion/bump2version for bumpver on readthedocs.org and other repos. Probably best to also switch this repo. The tooling is very similar.

agjohnson commented 2 years ago

Also, noted in a chat, we'll eventually have a slightly altered version number in package.json, which is primarily informational anyways, though might affect package installation too. This would be a good time to attempt reconfiguring versioning in package.json, as we are switching tools.

We don't really need to worry about the package.json version until Node 18 it sounds though, so a PEP440 style version is fine until then. We are stuck with Node 14 for the forseeable future.

Two options are either alter the version style, using the same version parts, or just truncate the version for package.json (".."). Either are fine I'm sure.

benjaoming commented 1 year ago

This sounds like a really good idea. Especially to sort out the different version schemes of PEP440 and npm, so the release process doesn't become vague or confusing.

I would really want to fix this, coinciding with #1362

benjaoming commented 1 year ago

Since package.json isn't part of the release but only part of the build stack, I think that truncating the version part (if possible) would be a great way to handle the problem :+1:

agjohnson commented 1 year ago

Let's just leave the version scheme as it is. It's not important to have this match Node versioning patterns, as we don't release to NPM. It's just updated in package.json for consistency.

benjaoming commented 1 year ago

Yes, I agree :+1:

agjohnson commented 1 year ago

Yup, I read that. You still seem to be advocating for altering the version for package.json. I'm describing take no action for package.json version -- it should match the version string from all other files.

benjaoming commented 1 year ago

Since we don't distribute this, I am happy to do whatever is most feasible to implement, as long as our npm commands "eat" it :)

humitos commented 1 month ago

We have the release process documented at https://sphinx-rtd-theme.readthedocs.io/en/stable/contributing.html#releasing-the-theme and we are already using bump2version. Closing.

agjohnson commented 1 month ago

This issue is low priority, but this issue is still valid. This is the only repo we're using bump2version, all other repos use bumpver. I think it still makes sense to standardize and it probably is not much work really.

humitos commented 1 month ago

Ahh.... I miss-read it. OK, re-opening then 😄