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

Switch to using bumpver #1324

Open
2 tasks
agjohnson opened this issue Aug 19, 2022 · 10 comments
Open
2 tasks

Switch to using bumpver #1324

agjohnson opened this issue Aug 19, 2022 · 10 comments
Labels
Improvement Minor improvement to code
Milestone

Comments

@agjohnson
Copy link
Collaborator

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.

  • Change configuration
  • Doc updates for release procedures
@agjohnson agjohnson added the Improvement Minor improvement to code label Aug 19, 2022
@agjohnson agjohnson added this to the 2.0 milestone Aug 19, 2022
@agjohnson
Copy link
Collaborator Author

agjohnson commented Aug 19, 2022

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
Copy link
Contributor

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
Copy link
Contributor

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 👍

@agjohnson
Copy link
Collaborator Author

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
Copy link
Contributor

Yes, I agree 👍

@agjohnson
Copy link
Collaborator Author

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
Copy link
Contributor

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
Copy link
Member

humitos commented Jul 24, 2024

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.

@humitos humitos closed this as completed Jul 24, 2024
@agjohnson
Copy link
Collaborator Author

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
Copy link
Member

humitos commented Jul 24, 2024

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

@humitos humitos reopened this Jul 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code
Projects
None yet
Development

No branches or pull requests

3 participants