Add publication time to registry package release metadata #6407
Conversation
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
Motivation: Registry should have information about how a package was published. This includes who published it, who signed it, and when it was published. - "Who published the package release?": this is `metadata.author`, which is already defined in the metadata JSON schema. - "Who signed the package release?": this can be extracted from the signing certificate if signed (requires rdar://107483043 and will be done in separate PR) - "When was the release published?": added in this PR rdar://106674475 Modifications: - Add `originalPublicationTime` to user-provided metadata during publication - Add `publishedAt` to registry's package release metadata response - Update registry API spec
yim-lee
commented
Apr 11, 2023
| | `author` | [Author](#author-type) | Author of the package release. | | | ||
| | `description` | String | A description of the package release. | | | ||
| | `licenseURL` | String | URL of the package release's license document. | | | ||
| | `originalPublicationTime` | String | Original publication time of the package release in [ISO 8601] format. This can be set if the package release was previously published elsewhere.<br>A registry should record the publication time independently and include it as `publishedAt` in the [package release metadata response](#42-fetch-information-about-a-package-release). <br>In case both `originalPublicationTime` and `publishedAt` are set, `originalPublicationTime` should be used. | | |
| | `version` | String | The package release version number. | ✓ | | ||
| | `resources` | Array | The resources available for the release. | ✓ | | ||
| | `metadata` | Object | Additional information about the release. | ✓ | | ||
| | `publishedAt` | String | The [ISO 8601]-formatted datetime string of when the package release was published, as recorded by the registry. See related [`originalPublicationTime`](#appendix-b---package-release-metadata-json-schema) in `metadata`. | | |
|
@swift-ci please smoke test |
|
@swift-ci please smoke test Linux |
1 similar comment
|
@swift-ci please smoke test Linux |
|
Can we also add this to |
|
@swift-ci please test Windows platform |
neonichu
reviewed
Apr 11, 2023
| } | ||
|
|
||
| // FIXME: This matches the current implementation, but we may want be smarter about it? | ||
| private func guessReadMeURL(baseURL: URL, defaultBranch: String) -> URL { | ||
| return baseURL.appendingPathComponent("raw").appendingPathComponent(defaultBranch).appendingPathComponent("README.md") |
neonichu
approved these changes
Apr 11, 2023
tomerd
approved these changes
Apr 11, 2023
tomerd
reviewed
Apr 11, 2023
| } | ||
|
|
There was a problem hiding this comment.
I wonder if we should remove readmeURL from the API and let the clients figure it out using their own logic.
yim-lee
added a commit
to yim-lee/swift-package-manager
that referenced
this pull request
Apr 11, 2023
…6407) * Add publication time to registry package release metadata Motivation: Registry should have information about how a package was published. This includes who published it, who signed it, and when it was published. - "Who published the package release?": this is `metadata.author`, which is already defined in the metadata JSON schema. - "Who signed the package release?": this can be extracted from the signing certificate if signed (requires rdar://107483043 and will be done in separate PR) - "When was the release published?": added in this PR rdar://106674475 Modifications: - Add `originalPublicationTime` to user-provided metadata during publication - Add `publishedAt` to registry's package release metadata response - Update registry API spec * Add publishedAt to PackageSearchClient
yim-lee
added a commit
that referenced
this pull request
Apr 12, 2023
) * Add publication time to registry package release metadata Motivation: Registry should have information about how a package was published. This includes who published it, who signed it, and when it was published. - "Who published the package release?": this is `metadata.author`, which is already defined in the metadata JSON schema. - "Who signed the package release?": this can be extracted from the signing certificate if signed (requires rdar://107483043 and will be done in separate PR) - "When was the release published?": added in this PR rdar://106674475 Modifications: - Add `originalPublicationTime` to user-provided metadata during publication - Add `publishedAt` to registry's package release metadata response - Update registry API spec * Add publishedAt to PackageSearchClient
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.
Motivation:
Registry should have information about how a package was published. This includes who published it, who signed it, and when it was published.
metadata.author, which is already defined in the metadata JSON schema.rdar://106674475
Modifications:
originalPublicationTimeto user-provided metadata during publicationpublishedAtto registry's package release metadata response