foster/forgejo
1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2024-12-26 13:29:12 -05:00
Code Issues Wiki Activity
forgejo/docs/content/doc/packages/rubygems.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.8 KiB
Raw Blame History

date title slug draft toc menu
2021-07-20T00:00:00+00:00 RubyGems Packages Repository usage/packages/rubygems false false
sidebar
parent name weight identifier
packages RubyGems 110 rubygems

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