linden123/githaven-fork
1
1
Fork 0
forked from Shiloh/githaven
Code Pull Requests Activity
6b0df6d8da
githaven-fork/docs/content/doc/packages/pub.en-us.md
Lunny Xiao e8433b7fe6
Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629) 
- **Installation**: includes how to install Gitea and related other
tools, also includes upgrade Gitea
- **Administration**: includes how to configure Gitea, customize Gitea
and manage Gitea instance out of Gitea admin UI
- **Usage**: includes how to use Gitea's functionalities. A sub
documentation is about packages, in future we could also include CI/CD
and others.
- **Development**: includes how to integrate with Gitea's API, how to
develop new features within Gitea
- **Contributing**: includes how to contribute code to Gitea
repositories.

After this is merged, I think we can have a sub-documentation of `Usage`
part named `Actions` to describe how to use Gitea actions

---------

Co-authored-by: John Olheiser <john.olheiser@gmail.com>
2023-03-23 23:18:24 +08:00

2.1 KiB
Raw Blame History

date title slug draft toc menu
2022-07-31T00:00:00+00:00 Pub Packages Repository usage/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/development/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/