You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+48-45Lines changed: 48 additions & 45 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,61 +56,64 @@ jobs:
56
56
57
57
## Inputs
58
58
59
-
### Cloud SDK inputs
60
-
61
-
- `skip_install`: (Optional) Skip the `gcloud` installation and use the
62
-
[system-installed gcloud][github-runners] instead. This can dramatically
63
-
improve workflow speeds at the expense of a slightly older gcloud version.
64
-
Setting this to `true` ignores any value for the `version` input. If you
65
-
skip installation, you will be unable to install components because the
66
-
system-install gcloud is locked. The default value is `false`. ⚠️ Be aware
67
-
that GitHub [plans to remove](https://github.com/actions/runner-images/issues/7101)
68
-
the system-installed gcloud, and any workflows with `skip_install: true`
69
-
will stop working when that happens.
70
-
71
-
- `version`: (Optional) A string representing the version or version
72
-
constraint of the Cloud SDK (`gcloud`) to install (e.g. `"290.0.1"` or `">=
73
-
197.0.1"`). The default value is `"latest"`, which will always download and
74
-
install the latest available Cloud SDK version.
75
-
76
-
```yaml
77
-
- uses: 'google-github-actions/setup-gcloud@v2'
78
-
with:
79
-
version: '>= 416.0.0'
80
-
```
59
+
<!-- BEGIN_AUTOGEN_INPUTS -->
60
+
61
+
- <a name="version"></a><a href="#user-content-version"><code>version</code></a>: _(Optional, default: `latest`)_ A string representing the version or version constraint of the Cloud SDK
62
+
(`gcloud`) to install (e.g. `"290.0.1"` or `">= 197.0.1"`). The default
63
+
value is `"latest"`, which will always download and install the latest
64
+
available Cloud SDK version.
81
65
82
-
If there is no installed `gcloud` version that matches the given constraint,
83
-
this GitHub Action will download and install the latest available version
84
-
that still matches the constraint.
66
+
- uses: 'google-github-actions/setup-gcloud@v2'
67
+
with:
68
+
version: '>= 416.0.0'
85
69
86
-
**Warning!** Workload Identity Federation requires version
70
+
If there is no installed `gcloud` version that matches the given
71
+
constraint, this GitHub Action will download and install the latest
72
+
available version that still matches the constraint.
73
+
74
+
Authenticating via Workload Identity Federation requires version
or newer. If you need support for Workload Identity Federation, specify your
89
-
version constraint as such:
76
+
or newer. If you need support for Workload Identity Federation, specify
77
+
your version constraint as such:
90
78
91
-
```yaml
92
-
- uses: 'google-github-actions/setup-gcloud@v2'
93
-
with:
94
-
version: '>= 363.0.0'
95
-
```
79
+
- uses: 'google-github-actions/setup-gcloud@v2'
80
+
with:
81
+
version: '>= 363.0.0'
96
82
97
83
You are responsible for ensuring the `gcloud` version matches the features
98
-
and components required. See the [gcloud release
99
-
notes][gcloud-release-notes] for a full list of versions.
84
+
and components required.
100
85
101
-
- `project_id`: (Optional) Project ID (**not** project _number_) of the Google
102
-
Cloud project. If provided, this will configure the `gcloud` CLI to use that
103
-
project ID for commands. Individual commands can still override the project
104
-
with the `--project` flag. If unspecified, the action attempts to find the
105
-
"best"project ID by looking at other inputs and environment variables.
86
+
- <a name="project_id"></a><a href="#user-content-project_id"><code>project_id</code></a>: _(Optional)_ ID of the Google Cloud project. If provided, this will configure gcloud to
87
+
use this project ID by default for commands. Individual commands can still
88
+
override the project using the `--project` flag which takes precedence. If
89
+
unspecified, the action attempts to find the "best" project ID by looking
90
+
at other inputs and environment variables.
106
91
107
-
- `install_components`: (Optional) List of [Cloud SDK
108
-
components](https://cloud.google.com/sdk/docs/components) to install
92
+
- <a name="install_components"></a><a href="#user-content-install_components"><code>install_components</code></a>: _(Optional)_ List of additional [gcloud
93
+
components](https://cloud.google.com/sdk/docs/components) to install,
- <a name="skip_install"></a><a href="#user-content-skip_install"><code>skip_install</code></a>: _(Optional)_ Skip installation of gcloud and use the [system-supplied
99
+
version](https://github.com/actions/runner-images) instead. If specified,
100
+
the `version` input is ignored.
101
+
102
+
⚠️ You will not be able to install additional gcloud components, because the
103
+
system installation is locked.
104
+
105
+
106
+
<!-- END_AUTOGEN_INPUTS -->
107
+
108
+
## Outputs
109
+
110
+
<!-- BEGIN_AUTOGEN_OUTPUTS -->
111
+
112
+
- `version`: Version of gcloud that was installed.
0 commit comments