mirrors/forgejo
1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2024-12-30 20:00:37 +00:00
Code Issues Projects Releases Packages Wiki Activity
forgejo/docs/content/doc/usage/packages/pub.en-us.md
John Olheiser bb25f85ce8
Refactor docs (#23752) 
This was intended to be a small followup for
https://github.com/go-gitea/gitea/pull/23712, but...here we are.

1. Our docs currently use `slug` as the entire URL, which makes
refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712).
Instead, this PR attempts to make future refactoring easier by using
slugs as an extension of the section. (Hugo terminology)
- What the above boils down to is this PR attempts to use directory
organization as URL management. e.g. `usage/comparison.en-us.md` ->
`en-us/usage/comparison/`, `usage/packages/overview.en-us.md` ->
`en-us/usage/packages/overview/`
- Technically we could even remove `slug`, as Hugo defaults to using
filename, however at least with this PR it means `slug` only needs to be
the name for the **current file** rather than an entire URL
2. This PR adds appropriate aliases (redirects) for pages, so anything
on the internet that links to our docs should hopefully not break.
3. A minor nit I've had for a while, renaming `seek-help` to `support`.
It's a minor thing, but `seek-help` has a strange connotation to it.
4. The commits are split such that you can review the first which is the
"actual" change, and the second is added redirects so that the first
doesn't break links elsewhere.

---------

Signed-off-by: jolheiser <john.olheiser@gmail.com>
2023-04-28 11:33:41 +08:00

2.1 KiB
Raw Blame History

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