Skip to content

Commit 012c06a

Browse files
Release: v2.7.5 (#575)
## What's Changed * Also cleanup cloudrun jobs by @sethvargo in #572 * feat: add support for --wait flag in jobs by @sethvargo in #571 * Print error messages before command by @sethvargo in #573 * Update deps by @sethvargo in #574 **Full Changelog**: v2.7.4...v2.7.5
1 parent 7071673 commit 012c06a

File tree

4 files changed

+34
-31
lines changed

4 files changed

+34
-31
lines changed

README.md

Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -55,16 +55,16 @@ jobs:
5555
5656
<!-- BEGIN_AUTOGEN_INPUTS -->
5757
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
5959
required unless providing `metadata` or `job`.
6060

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
6262
unless providing `metadata` or `service`.
6363

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
6565
unless providing `service` or `job`.
6666

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
6868
of the container image to deploy. For example:
6969

7070
us-docker.pkg.dev/cloudrun/container/hello:latest
@@ -73,19 +73,19 @@ jobs:
7373

7474
us-docker.pkg.dev/my-project/my-container/image:1.2.3
7575

76-
- <a name="source"></a><a href="#user-content-source"><code>source</code></a>: _(Optional)_ (Required, unless providing `metadata`, `image`, or `job`) Path to source
76+
- <a name="__input_source"></a><a href="#user-content-__input_source"><code>source</code></a>: _(Optional)_ (Required, unless providing `metadata`, `image`, or `job`) Path to source
7777
to deploy. If specified, this will deploy the Cloud Run service from the
7878
code specified at the given source directory.
7979

8080
Learn more about the required permissions in [Deploying from source
8181
code](https://cloud.google.com/run/docs/deploying-source-code).
8282

83-
- <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
8484
with the service name automatically. For example, specifying `v1` for a
8585
service named `helloworld`, would lead to a revision named
8686
`helloworld-v1`. This option only applies to services.
8787

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.
8989
These are comma-separated or newline-separated `KEY=VALUE`. Keys or values
9090
that contain separators must be escaped with a backslash (e.g. `\,` or
9191
`\\n`) unless quoted. Any leading or trailing whitespace is trimmed unless
@@ -102,7 +102,7 @@ jobs:
102102
If both `env_vars` and `env_vars_file` are specified, the keys in
103103
`env_vars` will take precedence over the keys in `env_vars_file`.
104104

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
106106
environment variables. The file can be newline-separated KEY=VALUE pairs,
107107
JSON, or YAML format. If both `env_vars` and `env_vars_file` are
108108
specified, the keys in env_vars will take precedence over the keys in
@@ -120,13 +120,13 @@ jobs:
120120
**⚠️ DEPRECATION NOTICE:** This input is deprecated and will be removed in
121121
the next major version release.
122122

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.
124124
If set to "merge", then the environment variables are _merged_ with any
125125
upstream values. If set to "overwrite", then all environment variables on
126126
the Cloud Run service will be replaced with exactly the values given by
127127
the GitHub Action (making it authoritative).
128128

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
130130
newline-separated `KEY=VALUE`. Keys or values that contain separators must
131131
be escaped with a backslash (e.g. `\,` or `\\n`) unless quoted. Any
132132
leading or trailing whitespace is trimmed unless values are quoted.
@@ -147,13 +147,13 @@ jobs:
147147
non-empty value is given, the field values will be overwritten (not
148148
merged). To remove all values, set the value to the literal string `{}`.
149149

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
151151
`merge`, then the secrets are merged with any upstream values. If set to
152152
`overwrite`, then all secrets on the Cloud Run service will be replaced
153153
with exactly the values given by the GitHub Action (making it
154154
authoritative).
155155

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
157157
comma-separated or newline-separated `KEY=VALUE`. Keys or values that
158158
contain separators must be escaped with a backslash (e.g. `\,` or `\\n`)
159159
unless quoted. Any leading or trailing whitespace is trimmed unless values
@@ -170,7 +170,7 @@ jobs:
170170
Google Cloud restricts the allowed values and length for labels. Please
171171
see the Google Cloud documentation for labels for more information.
172172

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
174174
came from GitHub Actions. The GitHub Action will automatically apply the
175175
following labels which Cloud Run uses to enhance the user experience:
176176

@@ -179,13 +179,13 @@ jobs:
179179

180180
Setting this to `true` will skip adding these special labels.
181181

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
183183
applies to services.
184184

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
186186
ten minutes and 5 seconds.
187187

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
189189
command. This can be used to apply advanced features that are not exposed
190190
via this GitHub Action. For Cloud Run services, this command will be
191191
`gcloud run deploy`. For Cloud Run jobs, this command will be `gcloud jobs
@@ -208,10 +208,13 @@ jobs:
208208
are responsible for making sure the flags are available on the gcloud
209209
version and subcommand.
210210

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
212212
only applies to services.
213213

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.
215218

216219
with:
217220
revision_traffic: 'my-revision=10' # percentage
@@ -224,15 +227,15 @@ jobs:
224227
This is mutually-exclusive with `tag_traffic`. This option only applies
225228
to services.
226229

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.
228231

229232
with:
230233
tag_traffic: 'my-tag=10' # percentage
231234

232235
This is mutually-exclusive with `revision_traffic`. This option only
233236
applies to services.
234237

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
236239
run services update-traffic` command. This can be used to apply advanced
237240
features that are not exposed via this GitHub Action. This flag only
238241
applies when `revision_traffic` or `tag_traffic` is set.
@@ -254,15 +257,15 @@ jobs:
254257
are responsible for making sure the flags are available on the gcloud
255258
version and subcommand.
256259

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.
258261

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.
260263

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",
262265
the latest available gcloud SDK version for the target platform will be
263266
installed. Example: "290.0.1".
264267

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.
266269

267270

268271
<!-- END_AUTOGEN_INPUTS -->
@@ -314,7 +317,7 @@ automatically private services, while deploying a revision of a public
314317

315318
<!-- BEGIN_AUTOGEN_OUTPUTS -->
316319

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.
318321

319322

320323
<!-- END_AUTOGEN_OUTPUTS -->

dist/main/index.js

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "deploy-cloudrun",
3-
"version": "2.7.4",
3+
"version": "2.7.5",
44
"description": "Github Action: Deploy to Google Cloud Run",
55
"main": "dist/index.js",
66
"scripts": {

0 commit comments

Comments
 (0)