cd docs git diff d3982bcd814bac93e3cbce1c7eb749b17e413fbd..e865de1e9d65dc09797d165a51c8e705d2a86030 -- $(find . -type f -name '*en-us*')
4.7 KiB
title | license | origin_url |
---|---|---|
Swift Packages Repository | Apache-2.0 | e865de1e9d/docs/content/usage/packages/swift.en-us.md |
Swift Packages Repository
Publish Swift packages for your user or organization.
Requirements
To work with the Swift package registry, you need to use swift to consume and a HTTP client (like curl
) to publish packages.
Configuring the package registry
To register the package registry and provide credentials, execute:
swift package-registry set https://forgejo.example.com/api/packages/{owner}/swift
swift package-registry login https://forgejo.example.com/api/packages/{owner}/swift --username {username} --password {password}
Placeholder | Description |
---|---|
owner |
The owner of the package. |
username |
Your Forgejo username. |
password |
Your Forgejo password. If you are using 2FA or OAuth use a personal access token instead of the password. |
The login is optional and only needed if the package registry is private.
Publish a package
First you have to pack the contents of your package:
swift package archive-source
To publish the package perform a HTTP PUT request with the package content in the request body.
curl -X PUT --user {username}:{password} \
-H "Accept: application/vnd.swift.registry.v1+json" \
-F source-archive=@/path/to/package.zip \
-F metadata={metadata} \
https://forgejo.example.com/api/packages/{owner}/swift/{scope}/{name}/{version}
Placeholder | Description |
---|---|
username |
Your Forgejo username. |
password |
Your Forgejo password. If you are using 2FA or OAuth use a personal access token instead of the password. |
owner |
The owner of the package. |
scope |
The package scope. |
name |
The package name. |
version |
The package version. |
metadata |
(Optional) The metadata of the package. JSON encoded subset of https://schema.org/SoftwareSourceCode |
You cannot publish a package if a package of the same name and version already exists. You must delete the existing package first.
The server responds with the following HTTP Status codes.
HTTP Status Code | Meaning |
---|---|
201 Created |
The package has been published. |
400 Bad Request |
The package is invalid. |
409 Conflict |
A package file with the same combination of parameters exists already. |
Install a package
To install a Swift package from the package registry, add it in the Package.swift
file dependencies list:
dependencies: [
.package(id: "{scope}.{name}", from:"{version}")
]
Parameter | Description |
---|---|
scope |
The package scope. |
name |
The package name. |
version |
The package version. |
Afterwards execute the following command to install it:
swift package resolve