0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-12-01 19:17:12 -05:00
forgejo-docs/docs/user/packages/swift.md
Earl Warren 983dff3d3e sync with Gitea abe8fe352711601fbcd24bf4505f7e0b81a93c5d
git diff bd4c7ce578956d9839309b16753bd5505b63b2e3..abe8fe352711601fbcd24bf4505f7e0b81a93c5d -- $(find . -type f -name '*en-us*')

(cherry picked from commit 0b81e66c45)
2023-10-08 15:57:26 +00:00

4.1 KiB

title license origin_url
Swift Packages Repository Apache-2.0 abe8fe3527/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 -login {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.

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