软件包仓库中的 Ruby gems

Tier: 基础版, 专业版, 旗舰版
Offering: JihuLab.com, 私有化部署
Status: 实验

History

引入于极狐GitLab 13.9，使用名为 rubygem_packages 的功能标志。默认禁用。此功能是一个实验功能。

此功能的可用性受控于功能标志。更多信息，可以查看历史。此功能仅为测试所用，还未生产就绪。

你可以将 Ruby gems 发布到项目的软件包仓库中。然后，你可以从 UI 或使用 API 下载它们。

此功能是一个实验。

认证到软件包仓库#

在与软件包仓库交互之前，你必须先对其进行认证。

要做到这一点，你可以使用：

具有 api 范围的个人访问令牌。
具有 read_package_registry、write_package_registry 或两者的部署令牌。
CI/CD 作业令牌。

例如：

使用访问令牌进行身份验证：

创建或编辑你的 ~/.gem/credentials 文件，并添加：

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

在此示例中：

<token> 必须是你的个人访问令牌或部署令牌的令牌值。
<project_id> 显示在项目概述页面上。

使用 CI/CD 作业令牌进行身份验证：

创建或编辑你的 .gitlab-ci.yml 文件，并添加：

yaml
1# assuming a my_gem.gemspec file is present in the repository with the version currently set to 0.0.1
2image: ruby
3
4run:
5  before_script:
6    - mkdir ~/.gem
7    - echo "---" > ~/.gem/credentials
8    - |
9      echo "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/rubygems: '${CI_JOB_TOKEN}'" >> ~/.gem/credentials
10    - chmod 0600 ~/.gem/credentials # rubygems requires 0600 permissions on the credentials file
11  script:
12    - gem build my_gem
13    - gem push my_gem-0.0.1.gem --host ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/rubygems

你还可以在提交到极狐GitLab的 ~/.gem/credentials 文件中使用 CI_JOB_TOKEN：

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

推送一个 Ruby gem#

先决条件：

你必须认证到软件包仓库。
你的 Ruby gem 必须小于或等于 3 GB。

要做到这一点：

运行类似的命令：

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

在此示例中，<host> 是你在设置身份验证时使用的 URL。例如：

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

当 gem 成功发布时，将显示类似这样的消息：

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

该 gem 被发布到你的软件包仓库，并显示在软件包和仓库页面上。极狐GitLab 处理和显示你的 gem 最多可能需要 10 分钟。

推送具有相同名称或版本的 gems#

如果已存在具有相同名称和版本的软件包，你可以推送一个 gem。两者在 UI 中都是可见和可访问的。

下载 gems#

你不能从极狐GitLab 的软件包仓库中安装 Ruby gems。但是，你可以下载 gem 文件以供本地使用。