google-github-actions/setup-gcloud@v3

Downloads, installs, and configures a Google Cloud SDK environment. Adds the `gcloud` CLI command to the $PATH.

At a glance

Latest major
v3
Repository
google-github-actions/setup-gcloud
Inputs
5 (0 required)
Outputs
1
Runs using
node24
License
Apache-2.0
Last checked

Inputs and outputs come straight from the action's official action.yml. See our editorial standards.

Usage

- uses: google-github-actions/setup-gcloud@v3

Inputs

NameRequiredDefaultDescription
versionNolatestA string representing the version or version constraint of the Cloud SDK (`gcloud`) to install (e.g. `"290.0.1"` or `">= 197.0.1"`). The default value is `"latest"`, which will always download and install the latest available Cloud SDK version. - uses: 'google-github-actions/setup-gcloud@v3' with: version: '>= 416.0.0' If there is no installed `gcloud` version that matches the given constraint, this GitHub Action will download and install the latest available version that still matches the constraint. Authenticating via Workload Identity Federation requires version [363.0.0](https://cloud.google.com/sdk/docs/release-notes#36300_2021-11-02) or newer. If you need support for Workload Identity
project_idNononeID of the Google Cloud project. If provided, this will configure gcloud to use this project ID by default for commands. Individual commands can still override the project using the `--project` flag which takes precedence. If unspecified, the action attempts to find the "best" project ID by looking at other inputs and environment variables.
install_componentsNononeList of additional [gcloud components](https://cloud.google.com/sdk/docs/components) to install, specified as a comma-separated list of strings: install_components: 'alpha,cloud-datastore-emulator'
skip_installNofalseSkip installation of gcloud and use the [system-supplied version](https://github.com/actions/runner-images) instead. If specified, the `version` input is ignored. ⚠️ You will not be able to install additional gcloud components, because the system installation is locked.
cacheNofalseTransfer the downloaded artifacts into the runner's tool cache. On GitHub-managed runners, this have very little impact since runneres are ephemeral. On self-hosted runners, this could improve future runs by skipping future gcloud installations.

Outputs

NameDescription
versionVersion of gcloud that was installed.

Read an output with ${{ steps.<step-id>.outputs.<name> }}; the step needs an id.

Examples

Install the gcloud CLI

Run after `auth` so later `gcloud` commands use those credentials.

name: Example
on:
  push:
    branches: [main]

permissions:
  contents: read

jobs:
  example:
    runs-on: ubuntu-latest
    steps:
      - name: Set up gcloud Cloud SDK environment
        uses: google-github-actions/setup-gcloud@v3
        with:
          version: ">= 500.0.0"
      - run: gcloud info

Each example passed actionlint (syntax, expressions and the inputs it knows for this action). They were not run in a live repository, so replace placeholder values such as names, ARNs and paths with your own.

Something out of date or wrong? Report it on our Contact page. This page is rebuilt from the action's repository roughly once a week.