gitea/docs/content/doc/packages/pub.en-us.md
KN4CK3R f55af4675c
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>
2022-08-07 18:09:54 +08:00

2.1 KiB

date title slug draft toc menu
2022-07-31T00:00:00+00:00 Pub Packages Repository packages/pub false false
sidebar
parent name weight identifier
packages Pub 90 pub

Pub Packages Repository

Publish Pub 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 and/or flutter.

The following examples use dart.

Configuring the package registry

To register the package registry and provide credentials, execute:

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:

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:

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:

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:

# 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/