githaven-fork/docs/content/doc/packages/rubygems.en-us.md

date	title	slug	draft	toc	menu
2021-07-20T00:00:00+00:00	RubyGems Packages Repository	packages/rubygems	false	false	sidebar parent name weight identifier packages RubyGems 100 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/developers/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