正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。
ドキュメントに関する現在のご利用体験についてお聞かせください。アンケートにご協力ください。

パッケージレジストリのCargoクレート

  • プラン: Free、Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated
  • ステータス: 実験的機能

この機能の利用可否は、機能フラグによって制御されます。詳細については、履歴を参照してください。この機能はテストには利用できますが、本番環境での使用には適していません。

Cargoクレート(Rustパッケージ)をプロジェクトのパッケージレジストリに公開できます。その後、Cargoを使用してインストールできます。

この機能の開発の詳細については、issue 33060を参照してください。

Cargoレジストリはプロジェクトでのみ利用できます。グループレジストリやインスタンスレジストリはありません。GitLabはスパースインデックスプロトコルのみをサポートしています。

パッケージレジストリに対して認証する

パッケージレジストリを操作する前に、認証する必要があります。

  1. プロジェクトで、.cargo/config.tomlファイルを作成または編集します。

  2. レジストリを追加します:

    toml
    [registries.gitlab]
    index = "sparse+https://<gitlab.example.com>/api/v4/projects/<project_id>/packages/cargo/"
    credential-provider = "cargo:token"

    次の値を置き換えます:

    • <gitlab.example.com>: GitLabインスタンスのホスト名。GitLab.comの場合は、gitlab.comを使用します。
    • <project_id>: プロジェクトID。

    index URLの末尾のスラッシュは必須です。

    [registries.gitlab]内のgitlabキーはレジストリ名です。これはローカルエイリアスであり、任意の名前を選択できます。このページの--registry gitlabコマンドはこの名前を使用します。

  3. 環境変数にトークンを設定します:

    shell
    export CARGO_REGISTRIES_GITLAB_TOKEN="Bearer <token>"

    変数名はCARGO_REGISTRIES_<NAME>_TOKENです。<NAME>は大文字のレジストリ名で、-は_に置き換えられます。たとえば、my-registryという名前のレジストリの場合は、CARGO_REGISTRIES_MY_REGISTRY_TOKENを使用します。

トークンを設定ファイルに保存しないでください。

トークンインストールに必要なスコープ公開に必要なスコープ
パーソナルアクセストークンapiapi
プロジェクトアクセストークンapiapi
詳細権限パーソナルアクセストークンPackage: ReadPackage: ReadとPackage: Create
デプロイトークンread_package_registryread_package_registryとwrite_package_registry
CI/CDジョブトークン該当なし該当なし

パブリックプロジェクトからのクレートのインストールは、トークンなしで誰でも行えます。プライベートプロジェクトおよび内部プロジェクトにはトークンが必要です。

クレートを公開する

前提条件:

クレートを公開するには:

  1. 次のコマンドを実行します:

    shell
    cargo publish --registry gitlab

    GitLabはバックグラウンドでクレートを処理します。処理が完了すると、クレートはレジストリインデックスとデプロイ > パッケージレジストリページに表示されます。

  2. オプション。クレートが誤ってcrates.ioに公開されるのを防ぐには、Cargo.tomlファイルの[package]セクションにpublishキーを追加します:

    toml
    [package]
    name = "my-crate"
    version = "0.1.0"
    publish = ["gitlab"]

GitLab CI/CDを使用して公開する

CI/CDジョブトークンを使用して、CI/CDジョブからクレートを公開できます。トークンや設定ファイルを作成する必要はありません。

.gitlab-ci.ymlファイルに以下を追加します:

yaml
publish:
  image: rust:1
  variables:
    CARGO_REGISTRIES_GITLAB_INDEX: "sparse+${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/cargo/"
    CARGO_REGISTRIES_GITLAB_TOKEN: "Bearer ${CI_JOB_TOKEN}"
  rules:
    - if: $CI_COMMIT_TAG
  script:
    - cargo publish --registry gitlab

クレート名とバージョン

クレート名は次の条件を満たす必要があります:

  • 文字で始める。
  • 64文字以下にする。
  • 文字、数字、ハイフン(-)、アンダースコア(_)のみを含める。

クレート名は大文字と小文字を区別せず、ハイフンとアンダースコアは同等として扱われます。たとえば、my_crateとMy-Crateは同じクレートを指します。

バージョンはセマンティックバージョンである必要があります。

既存のバージョンを公開することはできません。Cargoは、リクエストがGitLabに到達する前に停止します。リクエストがGitLabに到達した場合、GitLabはPackage already existsというメッセージとともに400エラーを返します。プロジェクトの重複パッケージ設定はCargoには適用されません。

パッケージ保護ルールはCargoクレートに適用されます。ルールがクレート名を保護している場合、GitLabは403エラーを返します。Cargoはこのエラーを出力します:

the remote server responded with an error (status 403 Forbidden): Package protected.

クレートをインストールする

前提条件:

クレートをインストールするには、次のいずれかの方法を使用します:

Cargo.tomlファイルで、[dependencies]セクションにクレートを追加します:

toml
[dependencies]
my-crate = { version = "0.1", registry = "gitlab" }

以下を実行します。

shell
cargo add my-crate --registry gitlab

バイナリを含むクレートをインストールするには、以下を実行します:

shell
cargo install my-crate --registry gitlab

crates.ioのクレートは、プロジェクトのレジストリのクレートと並行して引き続き動作します。

クレートを削除する

前提条件:

  • メンテナーまたはオーナーのロールを持っている必要があります。

パッケージを削除する前に、関連するセキュリティリスクを理解していることを確認してください。

パッケージを削除するには、次のいずれかの方法があります:

サポートされていないCargoコマンド

GitLabは次のコマンドをサポートしていません:

  • cargo yank
  • cargo search
  • cargo owner

バージョンを削除するには、パッケージを削除します。