Fix latest-by-scala-version badge summary to prefer releases #1330
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
rtyley
force-pushed
the
fix-summary-of-latest-versions-badge-to-prefer-releases
branch
6 times, most recently
from
d185480
to
9c07f4f
Compare
rtyley
commented
Jan 13, 2024
Comment on lines
-25
to
-35
| it("should provide a concise summary of latest versions") { | ||
| Badges.summaryOfLatestVersions( | ||
| Map( | ||
| `2.11` -> Seq(`7.0.0`, `7.1.0`), | ||
| `2.12` -> Seq(`7.0.0`, `7.1.0`, `7.2.0`), | ||
| `2.13` -> Seq(`7.0.0`, `7.1.0`, `7.2.0`, `7.3.0`), | ||
| `3` -> Seq(`7.2.0`, `7.3.0`) | ||
| ) | ||
| ) shouldBe "7.3.0 (Scala 3.x, 2.13), 7.2.0 (Scala 2.12), 7.1.0 (Scala 2.11)" | ||
| } | ||
|
|
There was a problem hiding this comment.
To take advantage of this being a simple unit test, I've moved it further down the file (along with a couple of other new unit tests) into BadgesUnitTests - this doesn't extend ControllerBaseSuite and so can be quickly run in IntelliJ, etc, without having to start docker.
rtyley
changed the title
rtyley
force-pushed
the
fix-summary-of-latest-versions-badge-to-prefer-releases
branch
from
9c07f4f
to
8b27462
Compare
Currently, for the `content-api-firehose-client`, the Scaladex badges page is showing some contrasting values: https://index.scala-lang.org/guardian/content-api-firehose-client/badges * The 'Latest version' badge is showing a good version: 1.0.12 * The 'JVM badge' (which shows a summary of latest versions by supported Scala version, introduced with scalacenter#660) is showing an undesireable pre-release version: 1.0.13-PREVIEW.rt-dbremove-travis-file.2024-01-10T1738.6e259255 You can see both values on the versions page, but only if you tick the 'Show pre-release versions' button: * https://index.scala-lang.org/guardian/content-api-firehose-client/artifacts/content-api-firehose-client * https://index.scala-lang.org/guardian/content-api-firehose-client/artifacts/content-api-firehose-client?pre-releases=true# This PR fixes the behaviour on the latest-by-scala-version badge to match the behaviour of the other badge - it does this with a new PreferReleases ordering for SemanticVersions.
rtyley
force-pushed
the
fix-summary-of-latest-versions-badge-to-prefer-releases
branch
from
8b27462
to
d16cc46
Compare
|
Thanks! I can confirm that the badges on this sample project now show the correct release version: https://index.scala-lang.org/rtyley/sample-project-using-gha-scala-library-release-workflow/badges
...even though there are 'higher' number preview releases:
|
rtyley
added a commit
to guardian/pan-domain-authentication
that referenced
this pull request
Apr 26, 2024
The Maven badges we were using don't understand about pre-release version numbers, thankfully the Scaladex badges do! See also: * guardian/gha-scala-library-release-workflow#19 (review) * scalacenter/scaladex#1330
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.
I just noticed that the versions shown in the Scaladex badges for
content-api-firehose-clientdon't match - one is showing the stable release number (1.0.12馃憤), and the other is showing a pre-release (less good):The 'Latest version' badge is showing a good version:
1.0.12The 'JVM badge':
1.0.13-PREVIEW.rt-dbremove-travis-file.2024-01-10T1738.6e259255The JVM badge shows a latest-by-scala-version summary I introduced with #660, but it looks like I missed out logic which is present in the other badge - preferring to show releases, and only showing pre-releases if they are the only available version!
This PR fixes the behaviour on the latest-by-scala-version badge to match the behaviour of the other badge - it does this with a new
PreferReleasesordering forSemanticVersions. I did have a look to see if I could refactor the logic used by the first badge to also make use of this ordering, but it would have required a bigger refactoring:scaladex/modules/server/src/main/scala/scaladex/server/route/Badges.scala
Lines 159 to 162 in 9c07f4f