realaravinth/forgejo-federation
1
0
Fork 0
Code Issues Pull requests 6 Projects Releases Packages Wiki Activity

add sparse url in cargo package guide (#26937)

Browse source 
Hello,

The current package guide for cargo gives you only the git index, with
the HTTP Index stabilized being used as default for crates.io and being
better for most use-cases.

However, it's not documented that gitea supports the sparse spec, and it
does not require the _crates-index git repo for the sparse api.

I personally think we should push users to use the sparse instead of the
git repository. (Even let users disable crates-index repos if they only
want to use sparse)
This commit is contained in:
merlleu 2023-09-13 06:14:10 +02:00 committed by GitHub
parent aaeec2a392
commit e6a059a3d0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 14 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/content/usage/packages/cargo.en-us.md
View file

@ -50,10 +50,11 @@ Add the following text to the configuration file located in the current users ho
default = "gitea" default = "gitea"
[registries.gitea] [registries.gitea]
index = "https://gitea.example.com/{owner}/_cargo-index.git" index = "sparse+https://gitea.example.com/api/packages/{owner}/cargo/" # Sparse index
# index = "https://gitea.example.com/{owner}/_cargo-index.git" # Git
[net] # [net]
git-fetch-with-cli = true # git-fetch-with-cli = true
``` ```
| Parameter | Description | | Parameter | Description |
@ -72,6 +73,12 @@ token = "Bearer {token}"
| --------- | ----------- | | --------- | ----------- |
| `token` | Your [personal access token](development/api-usage.md#authentication) | | `token` | Your [personal access token](development/api-usage.md#authentication) |
## Git vs Sparse
Currently, cargo supports two ways for fetching crates in a registry: Git index & sparse index.
Sparse index is the newest method and offers better performance when updating crates compared to git.
Since Rust 1.68, sparse is the default method for crates.io.
## Publish a package ## Publish a package
Publish a package by running the following command in your project: Publish a package by running the following command in your project:

3
docs/content/usage/packages/cargo.zh-cn.md
View file

@ -50,7 +50,8 @@ Cargo 将可用软件包的信息存储在一个存储在 git 仓库中的软件
default = "gitea" default = "gitea"
[registries.gitea] [registries.gitea]
index = "https://gitea.example.com/{owner}/_cargo-index.git" index = "sparse+https://gitea.example.com/api/packages/{owner}/cargo/" # Sparse index
# index = "https://gitea.example.com/{owner}/_cargo-index.git" # Git
[net] [net]
git-fetch-with-cli = true git-fetch-with-cli = true

3
templates/package/content/cargo.tmpl
View file

@ -8,7 +8,8 @@
default = "gitea" default = "gitea"
[registries.gitea] [registries.gitea]
index = "<gitea-origin-url data-url="{{AppSubUrl}}/{{.PackageDescriptor.Owner.Name}}/_cargo-index.git"></gitea-origin-url>" index = "<gitea-origin-url data-url="sparse+{{AppSubUrl}}/api/packages/{{.PackageDescriptor.Owner.Name}}/cargo/"></gitea-origin-url>" # Sparse index
# index = "<gitea-origin-url data-url="{{AppSubUrl}}/{{.PackageDescriptor.Owner.Name}}/_cargo-index.git"></gitea-origin-url>" # Git
[net] [net]
git-fetch-with-cli = true</code></pre></div> git-fetch-with-cli = true</code></pre></div>