foster/forgejo-docs
0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-12-26 22:51:22 -05:00
Code Issues Activity

docs: 1.20: swift.md: adapt to Forgejo

Browse source
This commit is contained in:
Earl Warren 2023-04-28 16:36:08 +02:00 committed by Caesar Schinas
parent 3d1e5eb62f
commit 0765580805
No known key found for this signature in database
GPG key ID: AE9108461BEA5ACF
2 changed files with 26 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
user/packages/index.md
View file

@ -23,6 +23,7 @@ The following package managers are currently supported:
| [Pub](pub) | Dart | `dart`, `flutter` | | [Pub](pub) | Dart | `dart`, `flutter` |
| [PyPI](pypi) | Python | `pip`, `twine` | | [PyPI](pypi) | Python | `pip`, `twine` |
| [RubyGems](rubygems) | Ruby | `gem`, `Bundler` | | [RubyGems](rubygems) | Ruby | `gem`, `Bundler` |
| [Swift](swift) | Swift | `swift` |
| [Vagrant](vagrant) | - | `vagrant` | | [Vagrant](vagrant) | - | `vagrant` |
**The following paragraphs only apply if Packages are not globally disabled!** **The following paragraphs only apply if Packages are not globally disabled!**

62
user/packages/swift.md
View file

@ -1,26 +1,14 @@
--- ---
date: "2023-01-10T00:00:00+00:00" layout: '~/layouts/Markdown.astro'
title: "Swift Packages Repository" title: 'Swift Packages Repository'
slug: "swift" license: 'Apache-2.0'
weight: 95 origin_url: 'https://github.com/go-gitea/gitea/blob/c709fa17a77eae391cafbe72d6b2594f74d86a60/docs/content/doc/packages/swift.en-us.md'
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "Swift"
weight: 95
identifier: "swift"
--- ---
# Swift Packages Repository # Swift Packages Repository
Publish [Swift](hhttps://www.swift.org/) packages for your user or organization. Publish [Swift](hhttps://www.swift.org/) packages for your user or organization.
**Table of Contents**
{{< toc >}}
## Requirements ## 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. 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: To register the package registry and provide credentials, execute:
```shell ```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 | | Placeholder | Description |
| ------------ | ----------- | | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `owner` | The owner of the package. | | `owner` | The owner of the package. |
| `username` | Your Gitea username. | | `username` | Your Forgejo 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. | | `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. 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" \ -H "Accept: application/vnd.swift.registry.v1+json" \
-F source-archive=@/path/to/package.zip \ -F source-archive=@/path/to/package.zip \
-F metadata={metadata} \ -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 | | Placeholder | Description |
| ----------- | ----------- | | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `username` | Your Gitea username. | | `username` | Your Forgejo 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. | | `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. | | `owner` | The owner of the package. |
| `scope` | The package scope. | | `scope` | The package scope. |
| `name` | The package name. | | `name` | The package name. |
| `version` | The package version. | | `version` | The package version. |
| `metadata` | (Optional) The metadata of the package. JSON encoded subset of https://schema.org/SoftwareSourceCode | | `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. 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 | | Parameter | Description |
| ----------- | ----------- | | --------- | -------------------- |
| `scope` | The package scope. | | `scope` | The package scope. |
| `name` | The package name. | | `name` | The package name. |
| `version` | The package version. | | `version` | The package version. |
Afterwards execute the following command to install it: Afterwards execute the following command to install it: