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

step runnerを手動でインストールします

  • プラン: Free、Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

step runnerは、ネイティブ関数をサポートしないexecutorでGitLab RunnerがGitLab Functionsを実行できるようにするバイナリです。これらのexecutorでは、パイプラインで関数を使用する前に、ジョブが実行されるホストまたはコンテナにstep runnerのバイナリをインストールする必要があります。

手動でのstep runnerインストールが必要なexecutor

step runnerを手動でインストールする必要があるかどうかは、お使いのexecutorによって異なります。以下の表は、手動でのstep runnerのインストールが必要なexecutorを示しています:

executor手動インストールが必要
Shellはい
SSHはい
Kubernetesはい
VirtualBoxはい
Parallelsはい
カスタムはい
インスタンスはい
DockerWindowsのみ
Docker AutoscalerWindowsのみ
Docker MachineWindowsのみ

手動インストールが不要なexecutorの場合、gitlab-runner-helperがstep runnerとして機能します。これらのexecutorには、step-runnerバイナリは存在せず、必要もありません。

変数アクセス制限

step runnerを手動でインストールしたexecutorでは、step runnerはジョブ変数と環境変数へのアクセスが制限されます:

構文利用可能な値
${{ vars.<name> }}プレフィックスがCI_DOCKER_、またはGITLAB_のジョブ変数のみ。
${{ env.<name> }}HTTPS_PROXY, HTTP_PROXY, NO_PROXY, http_proxy, https_proxy, no_proxy, all_proxy, LANG, LC_ALL, LC_CTYPE, LOGNAME, USER, PATH, SHELL, TERM, TMPDIR, TZ

step runnerを手動でインストールします

複数のプラットフォーム向けのコンパイルされたバイナリは、step runnerのリリースページから入手できます。サポートされているプラットフォームには、Windows、Linux、macOS、およびFreeBSDがあり、複数のアーキテクチャ(amd64、arm64、386、ARM、s390x、ppc64le)に対応しています。

バイナリの信頼性を検証します

インストールする前に、バイナリが改ざんされておらず、公式のGitLabチームから提供されていることを確認してください。

  1. GPG公開キーをダウンロードしてインポートします:

    # All platforms (requires gpg installed: https://gnupg.org/download/)
    curl -o step-runner.pub.gpg "https://gitlab.com/gitlab-org/step-runner/-/package_files/257922684/download"
    gpg --import step-runner.pub.gpg
    gpg --fingerprint

    インポートしたキーが以下と一致することを確認してください:

    キー属性
    名前GitLab, Inc.
    メールsupport@gitlab.com
    フィンガープリント0FCD 59B1 6F4A 62D0 3839 27A5 42FF CA71 62A5 35F5
    有効期限2029-01-05
  2. リリースページから、以下のファイルをダウンロードしてください:

    • お使いのプラットフォーム用のバイナリ(例: step-runner-linux-amd64またはstep-runner-darwin-arm64
    • step-runner-release.sha256
    • step-runner-release.sha256.asc
  3. GPG署名を検証します:

    # All platforms (requires gpg)
    gpg --verify step-runner-release.sha256.asc step-runner-release.sha256

    出力にはGood signatureメッセージが含まれているはずです。

  4. バイナリのチェックサムを検証します:

    # Linux
    sha256sum -c step-runner-release.sha256
    # macOS
    shasum -a 256 -c step-runner-release.sha256
    # Windows (PowerShell) — replace 'step-runner-windows-amd64.exe' with your binary name
    $binary = "step-runner-windows-amd64.exe"
    $expected = (Select-String -Path "step-runner-release.sha256" -Pattern $binary).Line.Split(" ")[0]
    $actual = (Get-FileHash -Algorithm SHA256 $binary).Hash.ToLower()
    if ($actual -eq $expected) { "OK" } else { "FAILED: checksum mismatch" }

    出力には、お使いのバイナリに対してOKが表示されるはずです。

step-runnerをPATHに追加します

バイナリをダウンロードして検証したら、ジョブが実行されるインスタンスのPATHで利用できるようにします。このインスタンスは、executorによってはホストマシンまたはコンテナの場合があります。

  1. バイナリをstep-runner(Windowsではstep-runner.exe)に名前変更します:

    mv step-runner-<os>-<arch> step-runner
  2. Unix系システムでは、バイナリを実行可能にします:

    chmod +x step-runner
  3. バイナリをPATH上のディレクトリに移動します:

    mv step-runner /usr/local/bin/