Improve python version formatting 🐍 affects [pypi piwheels github] #7682
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
chris48s
added
the
service-badge
|
PyvesB
previously approved these changes
Mar 5, 2022
There was a problem hiding this comment.
Looks good to me. 👍🏻 Interestingly , @paulmelnikow intended on using pep440 in #5592 as well.
Comment on lines
149
to
153
| return { | ||
| label: dependency, | ||
| message: version ? addv(version) : ref, | ||
| color: 'blue', | ||
| color: version ? pep440VersionColor(version) : 'blue', | ||
| } |
There was a problem hiding this comment.
Could we use renderVersionBadge here, either with a conditional or ternary operator? For example:
return version ? renderVersionBadge({ version, versionFormatter: pep440VersionColor })
: { label: dependency, message: ref, color: 'blue' }
There was a problem hiding this comment.
We'd have to extend renderVersionBadge() to also take a custom label. For this badge the label is the name of the locked dependency. Tbh I'm inclined to leave it
chris48s
force-pushed
the
pep440-versions
branch
from
59da343
to
cd0095f
Compare
|
I've rebased this to resolve the conflicts on package.json and package-lock.json as it was easier than doing it as a merge. No functional changes |
PyvesB
approved these changes
Mar 6, 2022
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.
After implementing the piwheels badge the other day I realised that I had just used
renderVersionBadge()but our standard version formattershields/services/color-formatters.js
Lines 16 to 20 in 76a64a7
isn't great for python packages because it will format something like
2.0.0rc1or2.0.0b2as "stable".Then I started pulling the thread and realised this problem actually also applies to some other python ecosystem badges.
so in this PR I have:
pep440VersionColor()formatter function which uses https://github.com/renovatebot/pep440 to parse versionsrenderVersionBadge()a custom formatter function as an optional param - this might be handy if we want to use a custom formatter for other package ecosystems.