mirror of
https://codeberg.org/forgejo/forgejo
synced 2024-11-27 04:06:10 +01:00
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>
2.8 KiB
2.8 KiB
| date | title | slug | weight | draft | toc | menu | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2021-07-20T00:00:00+00:00 | RubyGems Packages Repository | rubygems | 110 | false | false |
|
RubyGems Packages Repository
Publish RubyGems packages for your user or organization.
Table of Contents
{{< toc >}}
Requirements
To work with the RubyGems package registry, you need to use the gem command line tool to consume and publish packages.
Configuring the package registry
To register the package registry edit the ~/.gem/credentials file and add:
---
https://gitea.example.com/api/packages/{owner}/rubygems: Bearer {token}
| Parameter | Description |
|---|---|
owner |
The owner of the package. |
token |
Your [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}). |
For example:
---
https://gitea.example.com/api/packages/testuser/rubygems: Bearer 3bd626f84b01cd26b873931eace1e430a5773cc4
Publish a package
Publish a package by running the following command:
gem push --host {host} {package_file}
| Parameter | Description |
|---|---|
host |
URL to the package registry. |
package_file |
Path to the package .gem file. |
For example:
gem push --host https://gitea.example.com/api/packages/testuser/rubygems test_package-1.0.0.gem
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 you can use Bundler or gem.
Bundler
Add a new source block to your Gemfile:
source "https://gitea.example.com/api/packages/{owner}/rubygems" do
gem "{package_name}"
end
| Parameter | Description |
|---|---|
owner |
The owner of the package. |
package_name |
The package name. |
For example:
source "https://gitea.example.com/api/packages/testuser/rubygems" do
gem "test_package"
end
Afterwards run the following command:
bundle install
gem
Execute the following command:
gem install --host https://gitea.example.com/api/packages/{owner}/rubygems {package_name}
| Parameter | Description |
|---|---|
owner |
The owner of the package. |
package_name |
The package name. |
For example:
gem install --host https://gitea.example.com/api/packages/testuser/rubygems test_package
Supported commands
gem install
bundle install
gem push