bb25f85ce8
This was intended to be a small followup for https://github.com/go-gitea/gitea/pull/23712, but...here we are. 1. Our docs currently use `slug` as the entire URL, which makes refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712). Instead, this PR attempts to make future refactoring easier by using slugs as an extension of the section. (Hugo terminology) - What the above boils down to is this PR attempts to use directory organization as URL management. e.g. `usage/comparison.en-us.md` -> `en-us/usage/comparison/`, `usage/packages/overview.en-us.md` -> `en-us/usage/packages/overview/` - Technically we could even remove `slug`, as Hugo defaults to using filename, however at least with this PR it means `slug` only needs to be the name for the **current file** rather than an entire URL 2. This PR adds appropriate aliases (redirects) for pages, so anything on the internet that links to our docs should hopefully not break. 3. A minor nit I've had for a while, renaming `seek-help` to `support`. It's a minor thing, but `seek-help` has a strange connotation to it. 4. The commits are split such that you can review the first which is the "actual" change, and the second is added redirects so that the first doesn't break links elsewhere. --------- Signed-off-by: jolheiser <john.olheiser@gmail.com>
2.8 KiB
| date | title | slug | weight | draft | toc | menu | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2023-01-10T00:00:00+00:00 | Swift Packages Repository | swift | 95 | 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