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

Add changelog for 1.0.1 #2287

Merged
merged 2 commits into from
Jun 25, 2021
Merged

Conversation

consideRatio
Copy link
Member

@consideRatio consideRatio commented Jun 24, 2021

This is the first release since 1.0.0, and now when we can bump both the minor and patch version I'm not so confident on what version makes sense to bump, but I think this should be considered a patch release as its mostly docs and bugfixes.

But for example, if it would bump kubespawner from some minor version to another, then we should perhaps bump the Helm chart a minor version as well? But, perhaps when nbgitpuller is bumped from 0.9 to 0.10 we don't, because its part of singleuser-sample rather than something that provides core functionality?

@minrk
Copy link
Member

minrk commented Jun 25, 2021

I don't think any changes in singleuser-sample should require a version bump, since that isn't used by actual deployments. It's just a reference example, and more akin to docs when it comes to API-sensitivity.

if it would bump kubespawner from some minor version to another, then we should perhaps bump the Helm chart a minor version as well?

I think that's going to depend on the change. When we have a big bundle like this, I don't think we need to be extremely strict about semantic versioning, as it's only three numbers that distill tons of accumulated packages. If we've bumped kubespawner and it exposed an extra flag or two, I don't think we need to force a minor bump, patch is fine. If it's a truly new feature, especially one we expose and/or document here, then minor in the chart makes sense.

Taking a step back at semantic versioning to why we have three levels of changes:

  • major: there's a good chance you need to change things to keep your deployment working, so read carefully, backup, and test before upgrading
  • minor: there might be something new in here to look at, but anything that was working should keep working without modification
  • patch: principally bugs fixed, nothing new for most users. Unlikely to require much attention, unless there's a known bug you've been waiting to be fixed

I think it's also okay to think in terms of 'bigness'. A big change we don't think will break anything can still make a major release to signal its importance, etc.

@consideRatio
Copy link
Member Author

Thanks @minrk for reasoning aloud about this! I think what you say is very reasonable and i like the idea of allowing for some freedom of choice on the version rather than stricly commiting to act in a certain way based on some ruleset.

Copy link
Member

@sgibson91 sgibson91 left a comment

Choose a reason for hiding this comment

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

LGTM! And I agree with @minrk's semver discussion above. Great work!

@consideRatio
Copy link
Member Author

Thanks @sgibson91! I'll go for a release!

@consideRatio consideRatio merged commit c3e9106 into jupyterhub:main Jun 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants