setup gcloud
v2.1.2
setup-gcloud GitHub アクションGitHub Actions 環境で Google Cloud SDK を構成します。 Google Cloud SDK には、gcloud バイナリと gsutil バイナリの両方が含まれています。
または、他の Google Cloud GitHub アクションとネイティブに統合します。
これは正式にサポートされている Google 製品ではなく、Google Cloud サポート契約の対象でもありません。 Google Cloud プロダクトのバグを報告したり、機能をリクエストしたりするには、Google Cloud サポートにお問い合わせください。
このアクションには、gcloud コマンドを実行するための Google Cloud 認証情報が必要です。詳細については、「認可」を参照してください。
このアクションはノード 20 を使用して実行されます。セルフホスト型 GitHub Actions ランナーを使用している場合は、このバージョン以降をサポートするランナー バージョンを使用する必要があります。
jobs :
job_id :
# Add "id-token" with the intended permissions.
permissions :
contents : ' read '
id-token : ' write '
steps :
- id : ' auth '
uses : ' google-github-actions/auth@v2 '
with :
workload_identity_provider : ' projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider '
service_account : ' [email protected] '
- name : ' Set up Cloud SDK '
uses : ' google-github-actions/setup-gcloud@v2 '
with :
version : ' >= 363.0.0 '
- name : ' Use gcloud CLI '
run : ' gcloud info ' version : (オプション、デフォルト: latest )インストールする Cloud SDK ( gcloud ) のバージョンまたはバージョン制約を表す文字列 (例: "290.0.1"または">= 197.0.1" )。デフォルト値は"latest"で、常に最新の利用可能な Cloud SDK バージョンをダウンロードしてインストールします。
- uses: 'google-github-actions/setup-gcloud@v2'
with:
version: '>= 416.0.0'
指定された制約に一致するgcloudバージョンがインストールされていない場合、この GitHub アクションは、制約に一致する利用可能な最新バージョンをダウンロードしてインストールします。
Workload Identity Federation を介した認証には、バージョン 363.0.0 以降が必要です。 Workload Identity Federation のサポートが必要な場合は、次のようにバージョン制約を指定します。
- uses: 'google-github-actions/setup-gcloud@v2'
with:
version: '>= 363.0.0'
gcloudバージョンが必要な機能およびコンポーネントと一致していることを確認するのはお客様の責任です。
project_id : (オプション) Google Cloud プロジェクトの ID。指定した場合、コマンドに対してデフォルトでこのプロジェクト ID を使用するように gcloud が設定されます。個々のコマンドは、優先される--projectフラグを使用してプロジェクトをオーバーライドできます。指定しない場合、アクションは他の入力と環境変数を調べて「最適な」プロジェクト ID を見つけようとします。
install_components : (オプション)インストールする追加の gcloud コンポーネントのリスト。文字列のカンマ区切りリストとして指定します。
install_components: 'alpha,cloud-datastore-emulator'
skip_install : (オプション) gcloud のインストールをスキップし、代わりにシステム提供のバージョンを使用します。指定した場合、 version入力は無視されます。
version : インストールされている gcloud のバージョン。 setup-gcloudアクションは Cloud SDK ( gcloud ) をインストールします。 Google Cloud に対する認証を構成するには、まず google-github-actions/auth アクションを使用する必要があります。 authアクションはアプリケーションのデフォルト認証情報を設定し、 setup-gcloudアクションはこれらの認証情報を参照して gcloud credentials を構成します。次のオプションを使用して認証できます。
bqツールとgsutilツールを認証するには、Cloud SDK バージョン 390.0.0 以降を使用する必要があります。
jobs :
job_id :
# Add "id-token" with the intended permissions.
permissions :
contents : ' read '
id-token : ' write '
steps :
- id : ' auth '
uses : ' google-github-actions/auth@v2 '
with :
workload_identity_provider : ' projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider '
service_account : ' [email protected] '
- name : ' Set up Cloud SDK '
uses : ' google-github-actions/setup-gcloud@v2 '
- name : ' Use gcloud CLI '
run : ' gcloud info ' jobs :
job_id :
steps :
- id : ' auth '
uses : ' google-github-actions/auth@v2 '
with :
credentials_json : ' ${{ secrets.GCP_CREDENTIALS }} '
- name : ' Set up Cloud SDK '
uses : ' google-github-actions/setup-gcloud@v2 '
- name : ' Use gcloud CLI '
run : ' gcloud info 'Google Cloud Platform でホストされているセルフホスト ランナーを使用している場合、ランナーにアタッチされているサービス アカウントから認証情報が自動的に取得されます。このシナリオでは、google-github-actions/auth アクションを実行する必要はありません。
jobs :
job_id :
steps :
- name : ' Set up Cloud SDK '
uses : ' google-github-actions/setup-gcloud@v2 '
- name : ' Use gcloud CLI '
run : ' gcloud info '複数のサービス アカウントを使用するには、 setup-gcloud使用する前に 2 番目の認証手順を実行して認証情報を更新する必要があります。
jobs :
job_id :
# Add "id-token" with the intended permissions.
permissions :
contents : ' read '
id-token : ' write '
steps :
- id : ' auth service account 1 '
uses : ' google-github-actions/auth@v2 '
with :
workload_identity_provider : ' projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider '
service_account : ' [email protected] '
- name : ' Set up Cloud SDK '
uses : ' google-github-actions/setup-gcloud@v2 '
- name : ' Use gcloud CLI '
run : ' gcloud auth list --filter=status:ACTIVE --format="value(account)" '
# [email protected]
- id : ' auth service account 2 '
uses : ' google-github-actions/auth@v2 '
with :
credentials_json : ' ${{ secrets.GCP_CREDENTIALS }} '
- name : ' Set up Cloud SDK '
uses : ' google-github-actions/setup-gcloud@v2 '
- name : ' Use gcloud CLI '
run : ' gcloud auth list --filter=status:ACTIVE --format="value(account)" '
# [email protected] 利用可能な最新のメジャー バージョンに固定することをお勧めします。
- uses : ' google-github-actions/setup-gcloud@v2 'このアクションはセマンティック バージョニングに従おうとしますが、私たちは最終的には人間であり、時には間違いを犯すこともあります。誤って重大な変更を加えないようにするために、特定のバージョンに固定することもできます。
- uses : ' google-github-actions/[email protected] 'ただし、バージョン番号を明示的に更新しない限り、自動セキュリティ アップデートや新機能を入手することはできません。 MAJORとMAJOR.MINOR.PATCHバージョンのみを公開していることに注意してください。 MAJOR.MINORの浮動エイリアスはありません。
