Add description, homepage, documentation and repository fields for versions#9998
Merged
Conversation
Member
Author
|
RE database dump breaking change: I guess we could also denormalize the data from the |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #9998 +/- ##
==========================================
+ Coverage 89.49% 89.50% +0.01%
==========================================
Files 295 295
Lines 31233 31257 +24
==========================================
+ Hits 27951 27976 +25
+ Misses 3282 3281 -1 ☔ View full report in Codecov by Sentry. |
07143fb to
2d07f82
Compare
This comment was marked as outdated.
This comment was marked as outdated.
2d07f82 to
c593220
Compare
…ory` columns to the `versions` table
…ory` fields in the database
…elds on the `version` API
c593220 to
1da5646
Compare
Member
Author
|
7 days without any objections and we talked about this PR in the crates.io team meeting last week, also without any objections, so let's merge this :) |
This was referenced Nov 26, 2024
This file contains hidden or 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
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.
We currently save these fields only per crate, not per version. This means that for crates publishing bug fixes to older major versions, these fields might get overwritten with outdated metadata.
The solution to this is to read these per crate metadata fields from the "default version" of a crate instead.
This PR introduces four more metadata columns to the
versionstable (description,homepage,documentationandrepository) and exposes their values on the API. The rest of the code is not using these values yet since they will need to be backfilled from the stored crate files first. Once that has happened we could remove the fields from thecratestable and use the content from the default version of a crate instead.Potential downsides of this:
cratestable, or if we stop updating them, this will essentially be a breaking change to the database dump schema. while we should not see this as a hard blocker, we should be careful to not introduce breaking changes too often.Related: