0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-11-25 18:19:26 -05:00
forgejo-docs/user/packages/pub.md
Earl Warren 121a25e25e
docs: v1.20: sync Gitea 62ac3251fa545d32bdfc9ff824106b97ec63edbb
# Conflicts:
#	user/packages/alpine.md
#	user/packages/cran.md
#	user/packages/debian.md
#	user/packages/go.md
#	user/packages/rpm.md
2023-08-13 14:13:15 +01:00

2.1 KiB

layout title license origin_url
~/layouts/Markdown.astro Pub Package Registry Apache-2.0 62ac3251fa/docs/content/doc/usage/packages/pub.en-us.md

Publish Pub packages for your user or organization.

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://forgejo.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://forgejo.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://forgejo.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://forgejo.example.com/api/packages/testuser/pub/
# specify version
dart pub add mypackage:1.0.8 --hosted-url=https://forgejo.example.com/api/packages/testuser/pub/