Old version

This documentation is for a Forgejo version which is no longer supported.

To read the up-to-date documentation, navigate to the latest version.

Pub Package Registry

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
PlaceholderDescription
ownerThe owner of the package.

You need to provide your personal access token.

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
PlaceholderDescription
ownerThe 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/
ParameterDescription
ownerThe owner of the package.
package_nameThe 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/