e8433b7fe6
- **Installation**: includes how to install Gitea and related other tools, also includes upgrade Gitea - **Administration**: includes how to configure Gitea, customize Gitea and manage Gitea instance out of Gitea admin UI - **Usage**: includes how to use Gitea's functionalities. A sub documentation is about packages, in future we could also include CI/CD and others. - **Development**: includes how to integrate with Gitea's API, how to develop new features within Gitea - **Contributing**: includes how to contribute code to Gitea repositories. After this is merged, I think we can have a sub-documentation of `Usage` part named `Actions` to describe how to use Gitea actions --------- Co-authored-by: John Olheiser <john.olheiser@gmail.com>
2.8 KiB
| date | title | slug | draft | toc | menu | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2023-01-10T00:00:00+00:00 | Swift Packages Repository | usage/packages/swift | false | false |
|
Swift Packages Repository
Publish Swift packages for your user or organization.
Table of Contents
{{< toc >}}
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 -login {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]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) 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]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) 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