Skip to content

Commit 76fe2b2

Browse files
authored
1 parent 0df576f commit 76fe2b2

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

Documentation/PackageRegistry/PackageRegistryUsage.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,8 @@ and apply them automatically when making registry API requests.
127127
## Dependency Resolution Using Registry
128128

129129
Resolving a registry dependency involves these steps:
130-
1. Fetch a package's available versions by calling the [list package releases](https://github.com/apple/swift-package-manager/blob/main/Documentation/Registry.md#41-list-package-releases) API.
131-
2. Compute the dependency graph by [fetching manifest(s) for a package release](https://github.com/apple/swift-package-manager/blob/main/Documentation/Registry.md#43-fetch-manifest-for-a-package-release).
130+
1. Fetch a package's available versions by calling the [list package releases](Registry.md#41-list-package-releases) API.
131+
2. Compute the dependency graph by [fetching manifest(s) for a package release](Registry.md#43-fetch-manifest-for-a-package-release).
132132
3. Pinpoint the package version to use.
133133

134134
### Using registry for source control dependencies
@@ -151,7 +151,7 @@ they are considered different even though they are the same package,
151151
and would result in symbol clashes.
152152

153153
SwiftPM can deduplicate packages by performing a
154-
[lookup on the source control URL](https://github.com/apple/swift-package-manager/blob/main/Documentation/Registry.md#endpoint-5)
154+
[lookup on the source control URL](Registry.md#endpoint-5)
155155
(e.g., `https://github.com/mona/LinkedList`) to see if it is associated with
156156
any package identifier (e.g., `mona.LinkedList`).
157157

@@ -164,7 +164,7 @@ source control dependencies by setting one of these flags:
164164
## Dependency Download From Registry
165165

166166
After a registry dependency is resolved, SwiftPM can
167-
[download source archive](https://github.com/apple/swift-package-manager/blob/main/Documentation/Registry.md#endpoint-4)
167+
[download source archive](Registry.md#endpoint-4)
168168
of the computed package version from the registry.
169169

170170
### Checksum TOFU
@@ -173,7 +173,7 @@ SwiftPM performs checksum TOFU
173173
([trust-on-first-use](https://en.wikipedia.org/wiki/Trust_on_first_use))
174174
on the downloaded source archive. If the archive is downloaded
175175
for the first time, SwiftPM
176-
[fetches metadata of the package release](https://github.com/apple/swift-package-manager/blob/main/Documentation/Registry.md#endpoint-2)
176+
[fetches metadata of the package release](Registry.md#endpoint-2)
177177
to obtain the expected checksum. Otherwise, SwiftPM
178178
compares the checksum with that in local storage (`~/.swiftpm/security/fingerprints/`)
179179
saved from previous download.
@@ -273,7 +273,7 @@ OPTIONS:
273273
274274
The command creates source archive for the package release,
275275
optionally signs the package release, and
276-
[publishes the package release](https://github.com/apple/swift-package-manager/blob/main/Documentation/Registry.md#endpoint-6)
276+
[publishes the package release](Registry.md#endpoint-6)
277277
to the registry.
278278
279279
If authentication is required for package publication,

Documentation/PackageRegistry/Registry.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1273,7 +1273,7 @@ JSON schema below.
12731273
```json
12741274
{
12751275
"$schema": "https://json-schema.org/draft/2020-12/schema",
1276-
"$id": "https://github.com/apple/swift-package-manager/blob/main/Documentation/Registry.md",
1276+
"$id": "https://github.com/apple/swift-package-manager/blob/main/Documentation/PackageRegistry/Registry.md",
12771277
"title": "Package Release Metadata",
12781278
"description": "Metadata of a package release.",
12791279
"type": "object",
@@ -1368,7 +1368,7 @@ JSON schema below.
13681368
| `licenseURL` | String | URL of the package release's license document. | |
13691369
| `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. | |
13701370
| `readmeURL` | String | URL of the README specifically for the package release or broadly for the package. | |
1371-
| `repositoryURLs` | Array | Code repository URL(s) of the package. It is recommended to include all URL variations (e.g., SSH, HTTPS) for the same repository. This can be an empty array if the package does not have source control representation.<br/>Setting this property is one way through which a registry can obtain repository URL to package identifier mappings for the ["lookup package identifiers registered for a URL" API](https://github.com/apple/swift-package-manager/blob/main/Documentation/Registry.md#45-lookup-package-identifiers-registered-for-a-url). A registry may choose other mechanism(s) for package authors to specify such mappings. | |
1371+
| `repositoryURLs` | Array | Code repository URL(s) of the package. It is recommended to include all URL variations (e.g., SSH, HTTPS) for the same repository. This can be an empty array if the package does not have source control representation.<br/>Setting this property is one way through which a registry can obtain repository URL to package identifier mappings for the ["lookup package identifiers registered for a URL" API](Registry.md#45-lookup-package-identifiers-registered-for-a-url). A registry may choose other mechanism(s) for package authors to specify such mappings. | |
13721372

13731373
##### `Author` type
13741374

Sources/PackageCollectionsModel/Formats/v1.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ To begin, define the top-level metadata about the collection:
2828
Each item in the `packages` array is a package object with the following properties:
2929

3030
* `url`: The URL of the package. Currently only Git repository URLs are supported. URL should be HTTPS and may contain `.git` suffix.
31-
* `identity`: The [identity](https://github.com/apple/swift-package-manager/blob/main/Documentation/Registry.md#36-package-identification) of the package if published to registry. **Optional.**
31+
* `identity`: The [identity](https://github.com/apple/swift-package-manager/blob/main/Documentation/PackageRegistry/Registry.md#36-package-identification) of the package if published to registry. **Optional.**
3232
* `summary`: A description of the package. **Optional.**
3333
* `keywords`: An array of keywords that the package is associated with. **Optional.**
3434
* `readmeURL`: The URL of the package's README. **Optional.**
@@ -102,7 +102,7 @@ A version object has metadata extracted from `Package.swift` and optionally addi
102102
* `name`: License name. [SPDX identifier](https://spdx.org/licenses/) (e.g., `Apache-2.0`, `MIT`, etc.) preferred. Omit if unknown. **Optional.**
103103
* `author`: The package version's author. **Optional.**
104104
* `name`: The author of the package version.
105-
* `signer`: The signer of the package version. **Optional.** Refer to [documentation](https://github.com/apple/swift-package-manager/blob/main/Documentation/PackageRegistryUsage.md#package-signing) on package signing for details.
105+
* `signer`: The signer of the package version. **Optional.** Refer to [documentation](https://github.com/apple/swift-package-manager/blob/main/Documentation/PackageRegistry/PackageRegistryUsage.md#package-signing) on package signing for details.
106106
* `type`: The signer type. Currently the only valid value is `ADP` (Apple Developer Program).
107107
* `commonName`: The common name of the signing certificate's subject.
108108
* `organizationalUnitName`: The organizational unit name of the signing certificate's subject.

Sources/PackageCollectionsModel/PackageCollectionModel+v1.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ extension PackageCollectionModel.V1.Collection {
8282
/// The URL of the package. Currently only Git repository URLs are supported.
8383
public let url: URL
8484

85-
/// Package identity for registry (https://github.com/apple/swift-package-manager/blob/main/Documentation/Registry.md#36-package-identification).
85+
/// Package identity for registry (https://github.com/apple/swift-package-manager/blob/main/Documentation/PackageRegistry/Registry.md#36-package-identification).
8686
public let identity: String?
8787

8888
/// A description of the package.

Sources/PackageRegistry/RegistryClient.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public protocol RegistryClientDelegate {
2828
}
2929

3030
/// Package registry client.
31-
/// API specification: https://github.com/apple/swift-package-manager/blob/main/Documentation/Registry.md
31+
/// API specification: https://github.com/apple/swift-package-manager/blob/main/Documentation/PackageRegistry/Registry.md
3232
public final class RegistryClient: Cancellable {
3333
public typealias Delegate = RegistryClientDelegate
3434

0 commit comments

Comments
 (0)