mirror of
https://codeberg.org/forgejo/docs.git
synced 2024-12-24 22:32:43 -05:00
docs: 1.20: swift.md: adapt to Forgejo
This commit is contained in:
Earl Warren
Caesar Schinas
parent
3d1e5eb62f
commit
0765580805
2 changed files with 26 additions and 37 deletions
|
|
@ -23,6 +23,7 @@ The following package managers are currently supported:
|
|||
| [Pub](pub) | Dart | `dart`, `flutter` |
|
||||
| [PyPI](pypi) | Python | `pip`, `twine` |
|
||||
| [RubyGems](rubygems) | Ruby | `gem`, `Bundler` |
|
||||
| [Swift](swift) | Swift | `swift` |
|
||||
| [Vagrant](vagrant) | - | `vagrant` |
|
||||
|
||||
**The following paragraphs only apply if Packages are not globally disabled!**
|
||||
|
|
|
|||
|
|
@ -1,26 +1,14 @@
|
|||
---
|
||||
date: "2023-01-10T00:00:00+00:00"
|
||||
title: "Swift Packages Repository"
|
||||
slug: "swift"
|
||||
weight: 95
|
||||
draft: false
|
||||
toc: false
|
||||
menu:
|
||||
sidebar:
|
||||
parent: "packages"
|
||||
name: "Swift"
|
||||
weight: 95
|
||||
identifier: "swift"
|
||||
layout: '~/layouts/Markdown.astro'
|
||||
title: 'Swift Packages Repository'
|
||||
license: 'Apache-2.0'
|
||||
origin_url: 'https://github.com/go-gitea/gitea/blob/c709fa17a77eae391cafbe72d6b2594f74d86a60/docs/content/doc/packages/swift.en-us.md'
|
||||
---
|
||||
|
||||
# Swift Packages Repository
|
||||
|
||||
Publish [Swift](hhttps://www.swift.org/) packages for your user or organization.
|
||||
|
||||
**Table of Contents**
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
## Requirements
|
||||
|
||||
To work with the Swift package registry, you need to use [swift](https://www.swift.org/getting-started/) to consume and a HTTP client (like `curl`) to publish packages.
|
||||
|
|
@ -30,14 +18,14 @@ To work with the Swift package registry, you need to use [swift](https://www.swi
|
|||
To register the package registry and provide credentials, execute:
|
||||
|
||||
```shell
|
||||
swift package-registry set https://gitea.example.com/api/packages/{owner}/swift -login {username} -password {password}
|
||||
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 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. |
|
||||
| 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]({{< 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.
|
||||
|
||||
|
|
@ -56,18 +44,18 @@ 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}
|
||||
https://forgejo.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 |
|
||||
| Placeholder | Description |
|
||||
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `username` | Your Forgejo username. |
|
||||
| `password` | Your Forgejo 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.
|
||||
|
||||
|
|
@ -81,11 +69,11 @@ dependencies: [
|
|||
]
|
||||
```
|
||||
|
||||
| Parameter | Description |
|
||||
| ----------- | ----------- |
|
||||
| `scope` | The package scope. |
|
||||
| `name` | The package name. |
|
||||
| `version` | The package version. |
|
||||
| Parameter | Description |
|
||||
| --------- | -------------------- |
|
||||
| `scope` | The package scope. |
|
||||
| `name` | The package name. |
|
||||
| `version` | The package version. |
|
||||
|
||||
Afterwards execute the following command to install it:
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue