forgejo/docs/content/usage/packages/swift.en-us.md
CEnnis91 4b1b774ccd
[gitea] Fix incorrect link to swift doc and swift package-registry login command (#29096)
Fixes a few mistakes in the Swift package registry documentation.

Syntax for the `package-registry login` command can be found
[here](https://github.com/apple/swift-package-manager/blob/main/Documentation/PackageRegistry/PackageRegistryUsage.md#registry-authentication).
I was not sure the best way to compress all of that information, so I
just focused on making sure the incorrect `package-registry set` command
was fixed.

(cherry picked from commit eb5ddc0a78ecfe007a6e279a3c59711cdfb3f701)
2024-02-10 10:53:43 +01:00

3.2 KiB

date title slug sidebar_position draft toc menu
2023-01-10T00:00:00+00:00 Swift Package Registry swift 95 false false
sidebar
parent name sidebar_position identifier
packages Swift 95 swift

Swift Package Registry

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://gitea.example.com/api/packages/{owner}/swift
swift package-registry login https://gitea.example.com/api/packages/{owner}/swift --username {username} --password {password}
Placeholder Description
owner The owner of the package.
username Your Gitea username.
password Your Gitea 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://gitea.example.com/api/packages/{owner}/swift/{scope}/{name}/{version}
Placeholder Description
username Your Gitea username.
password Your Gitea 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