summaryrefslogtreecommitdiffstats
path: root/docs/content
diff options
context:
space:
mode:
authorKN4CK3R <admin@oldschoolhack.me>2022-08-07 12:09:54 +0200
committerGitHub <noreply@github.com>2022-08-07 18:09:54 +0800
commitf55af4675cbcb0170693caaeb5faa7707836de4c (patch)
tree8942f12d712396bd8c3fd381c5e33a8bab52edc8 /docs/content
parentd4326afb25ae84131d6b9fd61d6f869828f7704b (diff)
downloadgitea-f55af4675cbcb0170693caaeb5faa7707836de4c.tar.gz
gitea-f55af4675cbcb0170693caaeb5faa7707836de4c.zip
Add support for Pub packages (#20560)
* Added support for Pub packages. * Update docs/content/doc/packages/overview.en-us.md Co-authored-by: Gergely Nagy <algernon@users.noreply.github.com> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: Gergely Nagy <algernon@users.noreply.github.com> Co-authored-by: Lauris BH <lauris@nix.lv>
Diffstat (limited to 'docs/content')
-rw-r--r--docs/content/doc/packages/overview.en-us.md1
-rw-r--r--docs/content/doc/packages/pub.en-us.md83
-rw-r--r--docs/content/doc/packages/pypi.en-us.md2
-rw-r--r--docs/content/doc/packages/rubygems.en-us.md2
4 files changed, 86 insertions, 2 deletions
diff --git a/docs/content/doc/packages/overview.en-us.md b/docs/content/doc/packages/overview.en-us.md
index 81575b9ade..5e03b71017 100644
--- a/docs/content/doc/packages/overview.en-us.md
+++ b/docs/content/doc/packages/overview.en-us.md
@@ -34,6 +34,7 @@ The following package managers are currently supported:
| [Maven]({{< relref "doc/packages/maven.en-us.md" >}}) | Java | `mvn`, `gradle` |
| [npm]({{< relref "doc/packages/npm.en-us.md" >}}) | JavaScript | `npm`, `yarn` |
| [NuGet]({{< relref "doc/packages/nuget.en-us.md" >}}) | .NET | `nuget` |
+| [Pub]({{< relref "doc/packages/pub.en-us.md" >}}) | Dart | `dart`, `flutter` |
| [PyPI]({{< relref "doc/packages/pypi.en-us.md" >}}) | Python | `pip`, `twine` |
| [RubyGems]({{< relref "doc/packages/rubygems.en-us.md" >}}) | Ruby | `gem`, `Bundler` |
diff --git a/docs/content/doc/packages/pub.en-us.md b/docs/content/doc/packages/pub.en-us.md
new file mode 100644
index 0000000000..4d37662208
--- /dev/null
+++ b/docs/content/doc/packages/pub.en-us.md
@@ -0,0 +1,83 @@
+---
+date: "2022-07-31T00:00:00+00:00"
+title: "Pub Packages Repository"
+slug: "packages/pub"
+draft: false
+toc: false
+menu:
+ sidebar:
+ parent: "packages"
+ name: "Pub"
+ weight: 90
+ identifier: "pub"
+---
+
+# Pub Packages Repository
+
+Publish [Pub](https://dart.dev/guides/packages) packages for your user or organization.
+
+**Table of Contents**
+
+{{< toc >}}
+
+## Requirements
+
+To work with the Pub package registry, you need to use the tools [dart](https://dart.dev/tools/dart-tool) and/or [flutter](https://docs.flutter.dev/reference/flutter-cli).
+
+The following examples use dart.
+
+## Configuring the package registry
+
+To register the package registry and provide credentials, execute:
+
+```shell
+dart pub token add https://gitea.example.com/api/packages/{owner}/pub
+```
+
+| Placeholder | Description |
+| ------------ | ----------- |
+| `owner` | The owner of the package. |
+
+You need to provide your [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}).
+
+## Publish a package
+
+To publish a package, edit the `pubspec.yaml` and add the following line:
+
+```yaml
+publish_to: https://gitea.example.com/api/packages/{owner}/pub
+```
+
+| Placeholder | Description |
+| ------------ | ----------- |
+| `owner` | The owner of the package. |
+
+Now you can publish the package by running the following command:
+
+```shell
+dart pub publish
+```
+
+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 Pub package from the package registry, execute the following command:
+
+```shell
+dart pub add {package_name} --hosted-url=https://gitea.example.com/api/packages/{owner}/pub/
+```
+
+| Parameter | Description |
+| ----------------- | ----------- |
+| `owner` | The owner of the package. |
+| `package_name` | The package name. |
+
+For example:
+
+```shell
+# use latest version
+dart pub add mypackage --hosted-url=https://gitea.example.com/api/packages/testuser/pub/
+# specify version
+dart pub add mypackage:1.0.8 --hosted-url=https://gitea.example.com/api/packages/testuser/pub/
+```
diff --git a/docs/content/doc/packages/pypi.en-us.md b/docs/content/doc/packages/pypi.en-us.md
index af17fe8310..588df71d60 100644
--- a/docs/content/doc/packages/pypi.en-us.md
+++ b/docs/content/doc/packages/pypi.en-us.md
@@ -8,7 +8,7 @@ menu:
sidebar:
parent: "packages"
name: "PyPI"
- weight: 90
+ weight: 100
identifier: "pypi"
---
diff --git a/docs/content/doc/packages/rubygems.en-us.md b/docs/content/doc/packages/rubygems.en-us.md
index dd7ac9ee7e..d4ae30bbce 100644
--- a/docs/content/doc/packages/rubygems.en-us.md
+++ b/docs/content/doc/packages/rubygems.en-us.md
@@ -8,7 +8,7 @@ menu:
sidebar:
parent: "packages"
name: "RubyGems"
- weight: 100
+ weight: 110
identifier: "rubygems"
---