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

Fix version-number confusion - skip straight to v1.0.0! #59

Merged
merged 1 commit into from
Dec 11, 2024

Conversation

rtyley
Copy link
Member

@rtyley rtyley commented Dec 11, 2024

This library has had some version-number confusion:

  • v0.4.4 - 2023/03/17 - updated version.sbt
  • v0.5.0 - 2023/04/28 - did not update version.sbt (git tag)
  • v0.6.0 - 2023/05/05 - did not update version.sbt (and didn't get a git tag)
  • v0.4.5 - 2024/07/26 - picked up this smaller version number based on what was in version.sbt
  • v0.4.6 - 2023/07/30 - released as normal
  • ...etc

This repo adopted gha-scala-library-release-workflow with #47 and v0.4.5 in 2024/07/26 - before that the release procedure was much more manual & error-prone!

To get past the confusion, it's best to jump to a version number higher than 0.6.0 - and as this library, like all libraries that use gha-scala-library-release-workflow, is using early-semver, it makes sense to move past 0.y.z as a version number - under early-semver:

When the major version is 0, a minor version increment MAY contain both source and binary breakages, but a patch version increment MUST remain binary compatible.

To avoid the complication of trying to understand that, better to just get to v1 and above!

This library has had some version -number confusion:

* 0.4.4 - 2023/03/17 - updated version.sbt
* 0.5.0 - 2023/04/28 - did not update version.sbt - https://github.com/guardian/fastly-api-client/releases/tag/v0.5.0
* 0.6.0 - 2023/05/05 - did not update version.sbt - did not get a `git` tag
* 0.4.5 - 2024/07/26 - picked up this smaller version number based on what was in version.sbt
* 0.4.6 - 2023/07/30
* ...etc

This repo adopted `gha-scala-library-release-workflow` with #47
in 2024/07/26 - before that the release procedure was much more manual and error-prone!

To get past the confusion, it's best to jump to a version number higher than 0.6.0 -
and as this library, like all libraries that use `gha-scala-library-release-workflow`,
is using `early-semver`, it makes sense to move past 0.y.z as a version number - under
`early-semver`:

> When the major version is 0, a minor version increment MAY contain both source and binary breakages, but a patch version increment MUST remain binary compatible.

To avoid the complication of trying to understand that, better to just get to v1 and above.
@rtyley rtyley requested a review from a team as a code owner December 11, 2024 10:52
@rtyley rtyley requested a review from JamieB-gu December 11, 2024 10:53
@rtyley rtyley merged commit 562383e into main Dec 11, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants