0
0
Fork 0
mirror of https://github.com/go-gitea/gitea synced 2024-12-17 09:44:10 +01:00
gitea/docs/content/usage/packages/pub.en-us.md
John Olheiser bd4c7ce578
Docusaurus-ify (#26051)
This PR cleans up the docs in a way to make them simpler to ingest by
our [docs repo](https://gitea.com/gitea/gitea-docusaurus).

1. It includes all of the sed invocations our ingestion did, removing
the need to do it at build time.
2. It replaces the shortcode variable replacement method with
`@variable@` style, simply for easier sed invocations when required.
3. It removes unused files and moves the docs up a level as cleanup.

---------

Signed-off-by: jolheiser <john.olheiser@gmail.com>
2023-07-26 04:53:13 +00:00

2 KiB

date title slug sidebar_position draft toc menu
2022-07-31T00:00:00+00:00 Pub Package Registry pub 90 false false
sidebar
parent name sidebar_position identifier
packages Pub 90 pub

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://gitea.example.com/api/packages/{owner}/pub
Placeholder Description
owner The 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://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/