0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-12-12 20:53:30 -05:00
forgejo-docs/docs/user/packages/pub.md

70 lines
2.1 KiB
Markdown
Raw Normal View History

2023-02-26 18:08:07 -05:00
---
title: 'Pub Package Registry'
2023-03-03 01:44:11 -05:00
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/pub.en-us.md'
2023-02-26 18:08:07 -05:00
---
Publish [Pub](https://dart.dev/guides/packages) packages for your user or organization.
## 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://forgejo.example.com/api/packages/{owner}/pub
```
2023-03-03 01:44:11 -05:00
| Placeholder | Description |
| ----------- | ------------------------- |
| `owner` | The owner of the package. |
2023-02-26 18:08:07 -05:00
You need to provide your [personal access token](../../api-usage/#authentication).
2023-02-26 18:08:07 -05:00
## Publish a package
To publish a package, edit the `pubspec.yaml` and add the following line:
```yaml
publish_to: https://forgejo.example.com/api/packages/{owner}/pub
```
2023-03-03 01:44:11 -05:00
| Placeholder | Description |
| ----------- | ------------------------- |
| `owner` | The owner of the package. |
2023-02-26 18:08:07 -05:00
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://forgejo.example.com/api/packages/{owner}/pub/
```
2023-03-03 01:44:11 -05:00
| Parameter | Description |
| -------------- | ------------------------- |
| `owner` | The owner of the package. |
| `package_name` | The package name. |
2023-02-26 18:08:07 -05:00
For example:
```shell
# 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/
```