Refactor - use renderVersionBadge - part 4 [githubrelease githubtag] #10656
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
Sometimes API would indicate if a version is pre-release while the version number does not have to be semantically a prerelease like in github-release service. We don't use a isPrerelease that can also force a non-preleases as we trust here developer semantic over API tagging.
jNullj
added
developer-experience
This was referenced Nov 6, 2024
jNullj
changed the title
chris48s
reviewed
Nov 10, 2024
services/version.js
Outdated
| @@ -237,6 +237,7 @@ function rangeStart(v) { | |||
| * @param {string} [options.prefix] - The prefix to display on the message, such as ">=", "v", overrides the default behavior of using addv | |||
| * @param {string} [options.postfix] - The postfix to display on the message, such as "tested" | |||
| * @param {Function} [options.versionFormatter=versionColor] - The function to use to format the color of the badge based on the version number | |||
| * @param {boolean} [options.forcePrerelease] - Whether to force the badge to be considered a prerelease for cases where upstream API indicates a prerelease version but it is not semantically a prerelease | |||
There was a problem hiding this comment.
I'd probably just call this isPrerelease
The way I'd view this is not so much that we're allowing platforms to indicate that a semantically stable release is actually a pre-release. More just that it allows a platform to explicitly indicate a release is a pre-release rather than us having to try and infer it.
There was a problem hiding this comment.
Its probably for the better, our goal is to serve from upstream rather then infer our own conclusion.
Changed with c6714e3
chris48s
approved these changes
Nov 11, 2024
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.
This pull request refactors the codebase to use the renderVersionBadge function for rendering version badges.
Refactored github releases and github tags.
The pull request also modifies tests where needed.
I added
forcePrereleaseoption to renderVersionBadge for github, might be usefull for any api that indicates prerelease explicitly.while for github release we don't effect colors, for github tags this pr changes the logic a bit, and improves horizontal consistency.
we used to mark all tags blue if user picked latest over semver sort. this is odd as with releases we do mark prerelease in orange.
I guess the diffrence is due to api indicating prereleases, but we already try to guess prereleases in renderVersionBadge so i figured we might just as well try and use it while increasing consistency.
This PR should be the last in this refactor, we do have a few outliers services like `
visual-studio-app-center-releases-osversion
orclojars` but i couldn't find anything else to refactor, let me know if you find anything.Until you do, closes #2026