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
+28-25Lines changed: 28 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,16 +55,16 @@ jobs:
55
55
56
56
<!-- BEGIN_AUTOGEN_INPUTS -->
57
57
58
-
- <a name="service"></a><a href="#user-content-service"><code>service</code></a>: _(Optional)_ ID of the service or fully-qualified identifier of the service. This is
58
+
- <a name="__input_service"></a><a href="#user-content-__input_service"><code>service</code></a>: _(Optional)_ ID of the service or fully-qualified identifier of the service. This is
59
59
required unless providing `metadata` or `job`.
60
60
61
-
- <a name="job"></a><a href="#user-content-job"><code>job</code></a>: _(Optional)_ ID of the job or fully-qualified identifier of the job. This is required
61
+
- <a name="__input_job"></a><a href="#user-content-__input_job"><code>job</code></a>: _(Optional)_ ID of the job or fully-qualified identifier of the job. This is required
62
62
unless providing `metadata` or `service`.
63
63
64
-
- <a name="metadata"></a><a href="#user-content-metadata"><code>metadata</code></a>: _(Optional)_ YAML service description for the Cloud Run service. This is required
64
+
- <a name="__input_metadata"></a><a href="#user-content-__input_metadata"><code>metadata</code></a>: _(Optional)_ YAML service description for the Cloud Run service. This is required
65
65
unless providing `service` or `job`.
66
66
67
-
- <a name="image"></a><a href="#user-content-image"><code>image</code></a>: _(Optional)_ (Required, unless providing `metadata` or `source`) Fully-qualified name
67
+
- <a name="__input_image"></a><a href="#user-content-__input_image"><code>image</code></a>: _(Optional)_ (Required, unless providing `metadata` or `source`) Fully-qualified name
- <a name="suffix"></a><a href="#user-content-suffix"><code>suffix</code></a>: _(Optional)_ String suffix to append to the revision name. Revision names always start
83
+
- <a name="__input_suffix"></a><a href="#user-content-__input_suffix"><code>suffix</code></a>: _(Optional)_ String suffix to append to the revision name. Revision names always start
84
84
with the service name automatically. For example, specifying `v1` for a
85
85
service named `helloworld`, would lead to a revision named
86
86
`helloworld-v1`. This option only applies to services.
87
87
88
-
- <a name="env_vars"></a><a href="#user-content-env_vars"><code>env_vars</code></a>: _(Optional)_ List of environment variables that should be set in the environment.
88
+
- <a name="__input_env_vars"></a><a href="#user-content-__input_env_vars"><code>env_vars</code></a>: _(Optional)_ List of environment variables that should be set in the environment.
89
89
These are comma-separated or newline-separated `KEY=VALUE`. Keys or values
90
90
that contain separators must be escaped with a backslash (e.g. `\,` or
91
91
`\\n`) unless quoted. Any leading or trailing whitespace is trimmed unless
@@ -102,7 +102,7 @@ jobs:
102
102
If both `env_vars` and `env_vars_file` are specified, the keys in
103
103
`env_vars`will take precedence over the keys in `env_vars_file`.
104
104
105
-
- <a name="env_vars_file"></a><a href="#user-content-env_vars_file"><code>env_vars_file</code></a>: _(Optional)_ Path to a file on disk, relative to the workspace, that defines
105
+
- <a name="__input_env_vars_file"></a><a href="#user-content-__input_env_vars_file"><code>env_vars_file</code></a>: _(Optional)_ Path to a file on disk, relative to the workspace, that defines
106
106
environment variables. The file can be newline-separated KEY=VALUE pairs,
107
107
JSON, or YAML format. If both `env_vars` and `env_vars_file` are
108
108
specified, the keys in env_vars will take precedence over the keys in
@@ -120,13 +120,13 @@ jobs:
120
120
**⚠️ DEPRECATION NOTICE:** This input is deprecated and will be removed in
121
121
the next major version release.
122
122
123
-
- <a name="env_vars_update_strategy"></a><a href="#user-content-env_vars_update_strategy"><code>env_vars_update_strategy</code></a>: _(Required, default: `merge`)_ Controls how the environment variables are set on the Cloud Run service.
123
+
- <a name="__input_env_vars_update_strategy"></a><a href="#user-content-__input_env_vars_update_strategy"><code>env_vars_update_strategy</code></a>: _(Required, default: `merge`)_ Controls how the environment variables are set on the Cloud Run service.
124
124
If set to "merge", then the environment variables are _merged_ with any
125
125
upstream values. If set to "overwrite", then all environment variables on
126
126
the Cloud Run service will be replaced with exactly the values given by
127
127
the GitHub Action (making it authoritative).
128
128
129
-
- <a name="secrets"></a><a href="#user-content-secrets"><code>secrets</code></a>: _(Optional)_ List of KEY=VALUE pairs to use as secrets. These are comma-separated or
129
+
- <a name="__input_secrets"></a><a href="#user-content-__input_secrets"><code>secrets</code></a>: _(Optional)_ List of KEY=VALUE pairs to use as secrets. These are comma-separated or
130
130
newline-separated `KEY=VALUE`. Keys or values that contain separators must
131
131
be escaped with a backslash (e.g. `\,` or `\\n`) unless quoted. Any
132
132
leading or trailing whitespace is trimmed unless values are quoted.
@@ -147,13 +147,13 @@ jobs:
147
147
non-empty value is given, the field values will be overwritten (not
148
148
merged). To remove all values, set the value to the literal string `{}`.
149
149
150
-
- <a name="secrets_update_strategy"></a><a href="#user-content-secrets_update_strategy"><code>secrets_update_strategy</code></a>: _(Required, default: `merge`)_ Controls how the secrets are set on the Cloud Run service. If set to
150
+
- <a name="__input_secrets_update_strategy"></a><a href="#user-content-__input_secrets_update_strategy"><code>secrets_update_strategy</code></a>: _(Required, default: `merge`)_ Controls how the secrets are set on the Cloud Run service. If set to
151
151
`merge`, then the secrets are merged with any upstream values. If set to
152
152
`overwrite`, then all secrets on the Cloud Run service will be replaced
153
153
with exactly the values given by the GitHub Action (making it
154
154
authoritative).
155
155
156
-
- <a name="labels"></a><a href="#user-content-labels"><code>labels</code></a>: _(Optional)_ List of labels that should be set on the function. These are
156
+
- <a name="__input_labels"></a><a href="#user-content-__input_labels"><code>labels</code></a>: _(Optional)_ List of labels that should be set on the function. These are
157
157
comma-separated or newline-separated `KEY=VALUE`. Keys or values that
158
158
contain separators must be escaped with a backslash (e.g. `\,` or `\\n`)
159
159
unless quoted. Any leading or trailing whitespace is trimmed unless values
@@ -170,7 +170,7 @@ jobs:
170
170
Google Cloud restricts the allowed values and length for labels. Please
171
171
see the Google Cloud documentation for labels for more information.
172
172
173
-
- <a name="skip_default_labels"></a><a href="#user-content-skip_default_labels"><code>skip_default_labels</code></a>: _(Optional, default: `false`)_ Skip applying the special annotation labels that indicate the deployment
173
+
- <a name="__input_skip_default_labels"></a><a href="#user-content-__input_skip_default_labels"><code>skip_default_labels</code></a>: _(Optional, default: `false`)_ Skip applying the special annotation labels that indicate the deployment
174
174
came from GitHub Actions. The GitHub Action will automatically apply the
175
175
following labels which Cloud Run uses to enhance the user experience:
176
176
@@ -179,13 +179,13 @@ jobs:
179
179
180
180
Setting this to `true` will skip adding these special labels.
181
181
182
-
- <a name="tag"></a><a href="#user-content-tag"><code>tag</code></a>: _(Optional)_ Traffic tag to assign to the newly-created revision. This option only
182
+
- <a name="__input_tag"></a><a href="#user-content-__input_tag"><code>tag</code></a>: _(Optional)_ Traffic tag to assign to the newly-created revision. This option only
183
183
applies to services.
184
184
185
-
- <a name="timeout"></a><a href="#user-content-timeout"><code>timeout</code></a>: _(Optional)_ Maximum request execution time, specified as a duration like "10m5s" for
185
+
- <a name="__input_timeout"></a><a href="#user-content-__input_timeout"><code>timeout</code></a>: _(Optional)_ Maximum request execution time, specified as a duration like "10m5s" for
186
186
ten minutes and 5 seconds.
187
187
188
-
- <a name="flags"></a><a href="#user-content-flags"><code>flags</code></a>: _(Optional)_ Space separate list of additional Cloud Run flags to pass to the deploy
188
+
- <a name="__input_flags"></a><a href="#user-content-__input_flags"><code>flags</code></a>: _(Optional)_ Space separate list of additional Cloud Run flags to pass to the deploy
189
189
command. This can be used to apply advanced features that are not exposed
190
190
via this GitHub Action. For Cloud Run services, this command will be
191
191
`gcloud run deploy`. For Cloud Run jobs, this command will be `gcloud jobs
@@ -208,10 +208,13 @@ jobs:
208
208
are responsible for making sure the flags are available on the gcloud
209
209
version and subcommand.
210
210
211
-
- <a name="no_traffic"></a><a href="#user-content-no_traffic"><code>no_traffic</code></a>: _(Optional, default: `false`)_ If true, the newly deployed revision will not receive traffic. This option
211
+
- <a name="__input_no_traffic"></a><a href="#user-content-__input_no_traffic"><code>no_traffic</code></a>: _(Optional, default: `false`)_ If true, the newly deployed revision will not receive traffic. This option
212
212
only applies to services.
213
213
214
-
- <a name="revision_traffic"></a><a href="#user-content-revision_traffic"><code>revision_traffic</code></a>: _(Optional)_ Comma-separated list of revision traffic assignments.
214
+
- <a name="__input_wait"></a><a href="#user-content-__input_wait"><code>wait</code></a>: _(Optional, default: `true`)_ If true, the action will wait for the job to complete before exiting. This
215
+
option only applies to jobs.
216
+
217
+
- <a name="__input_revision_traffic"></a><a href="#user-content-__input_revision_traffic"><code>revision_traffic</code></a>: _(Optional)_ Comma-separated list of revision traffic assignments.
215
218
216
219
with:
217
220
revision_traffic: 'my-revision=10'# percentage
@@ -224,15 +227,15 @@ jobs:
224
227
This is mutually-exclusive with `tag_traffic`. This option only applies
225
228
to services.
226
229
227
-
- <a name="tag_traffic"></a><a href="#user-content-tag_traffic"><code>tag_traffic</code></a>: _(Optional)_ Comma-separated list of tag traffic assignments.
230
+
- <a name="__input_tag_traffic"></a><a href="#user-content-__input_tag_traffic"><code>tag_traffic</code></a>: _(Optional)_ Comma-separated list of tag traffic assignments.
228
231
229
232
with:
230
233
tag_traffic: 'my-tag=10'# percentage
231
234
232
235
This is mutually-exclusive with `revision_traffic`. This option only
233
236
applies to services.
234
237
235
-
- <a name="update_traffic_flags"></a><a href="#user-content-update_traffic_flags"><code>update_traffic_flags</code></a>: _(Optional)_ Space separate list of additional Cloud Run flags to pass to the `gcloud
238
+
- <a name="__input_update_traffic_flags"></a><a href="#user-content-__input_update_traffic_flags"><code>update_traffic_flags</code></a>: _(Optional)_ Space separate list of additional Cloud Run flags to pass to the `gcloud
236
239
run services update-traffic` command. This can be used to apply advanced
237
240
features that are not exposed via this GitHub Action. This flag only
238
241
applies when `revision_traffic` or `tag_traffic` is set.
@@ -254,15 +257,15 @@ jobs:
254
257
are responsible for making sure the flags are available on the gcloud
255
258
version and subcommand.
256
259
257
-
- <a name="project_id"></a><a href="#user-content-project_id"><code>project_id</code></a>: _(Optional)_ ID of the Google Cloud project in which to deploy the service.
260
+
- <a name="__input_project_id"></a><a href="#user-content-__input_project_id"><code>project_id</code></a>: _(Optional)_ ID of the Google Cloud project in which to deploy the service.
258
261
259
-
- <a name="region"></a><a href="#user-content-region"><code>region</code></a>: _(Optional, default: `us-central1`)_ Region in which the Cloud Run services are deployed.
262
+
- <a name="__input_region"></a><a href="#user-content-__input_region"><code>region</code></a>: _(Optional, default: `us-central1`)_ Region in which the Cloud Run services are deployed.
260
263
261
-
- <a name="gcloud_version"></a><a href="#user-content-gcloud_version"><code>gcloud_version</code></a>: _(Optional)_ Version of the Cloud SDK to install. If unspecified or set to "latest",
264
+
- <a name="__input_gcloud_version"></a><a href="#user-content-__input_gcloud_version"><code>gcloud_version</code></a>: _(Optional)_ Version of the Cloud SDK to install. If unspecified or set to "latest",
262
265
the latest available gcloud SDK version for the target platform will be
263
266
installed. Example: "290.0.1".
264
267
265
-
- <a name="gcloud_component"></a><a href="#user-content-gcloud_component"><code>gcloud_component</code></a>: _(Optional)_ Version of the Cloud SDK components to install and use.
268
+
- <a name="__input_gcloud_component"></a><a href="#user-content-__input_gcloud_component"><code>gcloud_component</code></a>: _(Optional)_ Version of the Cloud SDK components to install and use.
266
269
267
270
268
271
<!-- END_AUTOGEN_INPUTS -->
@@ -314,7 +317,7 @@ automatically private services, while deploying a revision of a public
314
317
315
318
<!-- BEGIN_AUTOGEN_OUTPUTS -->
316
319
317
-
- `url`: The URL of the Cloud Run service.
320
+
- <a name="__output_url"></a><a href="#user-content-__output_url"><code>url</code></a>: The URL of the Cloud Run service.
0 commit comments