Remove underscores from PREVIEW version-numbers, complying with SemVer and fixing for sbt-release
#27
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The branch name of `update/non_aws` caused problems with the PREVIEW release workflow in this recent run for guardian/atom-maker#96: https://github.com/guardian/atom-maker/actions/runs/7905475560/job/21578205513 We saw this error from `sbt-release`: ``` Version [3.0.0-PREVIEW.updatenon_aws.2024-02-14T1807.431c7567] format is not compatible with ([0-9]+)((?:\.[0-9]+)+)?([\.\-0-9a-zA-Z]*)? ``` You can see that the existing branch-name-cleanup code in `gha-scala-library-release-workflow` (see https://github.com/guardian/gha-scala-library-release-workflow/blob/26b2cde0632c786fea6a4fc4b40c7a3cfbaa68bb/.github/workflows/reusable-release.yml#L87 , and in particular the `${GITHUB_REF_NAME//[^[:alnum:]-_]/}` part) has already done a bit of cleanup on the original branch name `update/non_aws` - making it into `updatenon_aws` with the slash (`/`) stripped out, but it's the remaining _underscore_ (`_`) that's causing the problem - the regex `sbt-release` is using for version numbers, defined here: https://github.com/sbt/sbt-release/blob/v1.4.0/src/main/scala/Version.scala#L58 ...specifically the `([\.\-0-9a-zA-Z]*)` bit, doesn't like underscores in version numbers, so the `non_aws` part is no good, and we get the version format error. Note that the current semver spec (2.0.0) has a tight constraint on allowable characters in a version string: "Identifiers MUST comprise only ASCII alphanumerics and hyphens [0-9A-Za-z-]" -- https://semver.org/#spec-item-9 ...so `sbt-release` is correct here, we shouldn't allow underscores. Consequently, this change ensures we strip underscores too - you can check this at the bash prompt like this: ``` $ GITHUB_REF_NAME="update/non_aws/roberto-tyley-is-da-coolest.so-true" $ echo "-PREVIEW.${GITHUB_REF_NAME//[^[:alnum:]-]/}.$(date +%Y-%m-%dT%H%M)" -PREVIEW.updatenonawsroberto-tyley-is-da-coolestso-true.2024-02-16T1503 ``` It would probably be nicer to convert slashes and underscores to dashes, but this at least should produce stuff that `sbt-release` doesn't mind.
rtyley
commented
Feb 16, 2024
| version_suffix="-PREVIEW.${GITHUB_REF_NAME//[^[:alnum:]-_]/}.$(date +%Y-%m-%dT%H%M).${GITHUB_SHA:0:8}" | ||
| version_suffix="-PREVIEW.${GITHUB_REF_NAME//[^[:alnum:]-]/}.$(date +%Y-%m-%dT%H%M).${GITHUB_SHA:0:8}" |
There was a problem hiding this comment.
You can check this at the bash prompt like this:
$ GITHUB_REF_NAME="update/non_aws/roberto-tyley-is-da-coolest.so-true"
$ echo "-PREVIEW.${GITHUB_REF_NAME//[^[:alnum:]-]/}.$(date +%Y-%m-%dT%H%M)"
-PREVIEW.updatenonawsroberto-tyley-is-da-coolestso-true.2024-02-16T1503
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The branch name of
update/non_awscaused problems with the PREVIEW release workflow in this recent release run for guardian/atom-maker#96 - this error fromsbt-releasekilled the run:You can see that
gha-scala-library-release-workflow's existing branch-name-cleanup code (added with #19) has already cleaned up the original branch nameupdate/non_awsa bit - making it intoupdatenon_awswith the slash (/) stripped out, but it's the remaining underscore (_) that's causing the problem.The regex
sbt-releaseis using for version numbers, defined here (specifically the([\.\-0-9a-zA-Z]*)bit) doesn't like underscores, so thenon_awspart is no good, and we get the version format error.The SemVer spec agrees - underscores are not allowed!
Note that the current semver spec (2.0.0) has a tight constraint on allowable characters in versions:
...so
sbt-releaseis correct here, we shouldn't allow underscores. Consequently, this change ensures we strip underscores too!