bb25f85ce8
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>
3.1 KiB
| date | title | slug | weight | draft | toc | menu | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2022-11-20T00:00:00+00:00 | Cargo Packages Repository | cargo | 5 | false | false |
|
Cargo Packages Repository
Publish Cargo packages for your user or organization.
Table of Contents
{{< toc >}}
Requirements
To work with the Cargo package registry, you need Rust and Cargo.
Cargo stores informations about the available packages in a package index stored in a git repository. This repository is needed to work with the registry. The following section describes how to create it.
Index Repository
Cargo stores informations about the available packages in a package index stored in a git repository.
In Gitea this repository has the special name _cargo-index.
After a package was uploaded, its metadata is automatically written to the index.
The content of this repository should not be manually modified.
The user or organization package settings page allows to create the index repository along with the configuration file. If needed this action will rewrite the configuration file. This can be useful if for example the Gitea instance domain was changed.
If the case arises where the packages stored in Gitea and the information in the index repository are out of sync, the settings page allows to rebuild the index repository. This action iterates all packages in the registry and writes their information to the index. If there are lot of packages this process may take some time.
Configuring the package registry
To register the package registry the Cargo configuration must be updated.
Add the following text to the configuration file located in the current users home directory (for example ~/.cargo/config.toml):
[registry]
default = "gitea"
[registries.gitea]
index = "https://gitea.example.com/{owner}/_cargo-index.git"
[net]
git-fetch-with-cli = true
| Parameter | Description |
|---|---|
owner |
The owner of the package. |
If the registry is private or you want to publish new packages, you have to configure your credentials.
Add the credentials section to the credentials file located in the current users home directory (for example ~/.cargo/credentials.toml):
[registries.gitea]
token = "Bearer {token}"
| Parameter | Description |
|---|---|
token |
Your [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) |
Publish a package
Publish a package by running the following command in your project:
cargo 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 package from the package registry, execute the following command:
cargo add {package_name}
| Parameter | Description |
|---|---|
package_name |
The package name. |
Supported commands
cargo publish
cargo add
cargo install
cargo yank
cargo unyank
cargo search