ContextQMD
Back to Gitlabhq

Ruby gems in the package registry

doc/user/packages/rubygems_registry/_index.md

18.11.24.9 KB
Original Source

{{< details >}}

  • Tier: Free, Premium, Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
  • Status: Experiment

{{< /details >}}

{{< history >}}

{{< /history >}}

[!flag] The availability of this feature is controlled by a feature flag. For more information, see the history. This feature is available for testing, but not ready for production use.

You can publish Ruby gems to your project's package registry. Then, you can download them from the UI or with the API.

This feature is an experiment. For more information about the development of this feature, see epic 3200.

Authenticate to the package registry

Before you can interact with the package registry, you must authenticate to it.

To do this, you can use:

For example:

{{< tabs >}}

{{< tab title="With an access token" >}}

To authenticate with an access token:

  • Create or edit your ~/.gem/credentials file, and add:

    ini
    ---
https://gitlab.example.com/api/v4/projects/<project_id>/packages/rubygems: '<token>'

In this example:

  • <token> must be the token value of either your personal access token or deploy token.
  • <project_id> is displayed on the project overview page.

{{< /tab >}}

{{< tab title="With a CI/CD job token" >}}

To authenticate with a CI/CD job token:

  • Create or edit your .gitlab-ci.yml file, and add:

    yaml
    # assuming a my_gem.gemspec file is present in the repository with the version currently set to 0.0.1
image: ruby

run:
  before_script:
    - mkdir ~/.gem
    - echo "---" > ~/.gem/credentials
    - |
      echo "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/rubygems: '${CI_JOB_TOKEN}'" >> ~/.gem/credentials
    - chmod 0600 ~/.gem/credentials # rubygems requires 0600 permissions on the credentials file
  script:
    - gem build my_gem
    - gem push my_gem-0.0.1.gem --host ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/rubygems

    You can also use CI_JOB_TOKEN in a ~/.gem/credentials file you check in to GitLab:

    ini
    ---
https://gitlab.example.com/api/v4/projects/${env.CI_PROJECT_ID}/packages/rubygems: '${env.CI_JOB_TOKEN}'

{{< /tab >}}

{{< /tabs >}}

Push a Ruby gem

Prerequisites:

To do this:

  • Run a command like:

    shell
    gem push my_gem-0.0.1.gem --host <host>

    In this example, <host> is the URL you used when setting up authentication. For example:

    shell
    gem push my_gem-0.0.1.gem --host https://gitlab.example.com/api/v4/projects/1/packages/rubygems

When a gem is published successfully, a message like this is displayed:

plaintext
Pushing gem to https://gitlab.example.com/api/v4/projects/1/packages/rubygems...
{"message":"201 Created"}

The gem is published to your package registry, and is shown on the Packages and registries page. It can take up to 10 minutes before GitLab processes and displays your gem.

Pushing gems with the same name or version

You can push a gem if a package of the same name and version already exists. Both are visible and accessible in the UI.

Delete a Ruby gem

Prerequisites:

  • You must have the Maintainer or Owner role.

Before you delete a package, make sure you understand the associated security risks.

To delete a package, you can either:

Download gems

You can't install Ruby gems from the GitLab package registry. However, you can download gem files for local use.

To do this:

  1. In the top bar, select Search or go to and find your project.
  2. Select Deploy > Package registry.
  3. Select the package name and version.
  4. Under Assets, select the Ruby gem you want to download.

To download Ruby gems, you can also use the API.