feat: add timeout option for setting execution timeouts (#291)

Author: sethvargo

README.md

@@ -83,6 +83,7 @@ jobs:
 | `source` | _optional_ | | Deploy from source by specifying the source directory. The [Artifact Registry API][artifact-api] needs to be enabled and the service account role `Cloud Build Service Account` is required. The first deployment will create an [Artifact Registry repository][repo] which requires the `Artifact Registry Admin` role. Learn more about [Deploying from source code](https://cloud.google.com/run/docs/deploying-source-code). |
 | `suffix` | _optional_ | | Specify the suffix of the revision name. Revision names always start with named 'helloworld', would lead to a revision named 'helloworld-v1'. |
 | `tag` | _optional_ | | Traffic tag to assign to the newly created revision. |
+| `timeout` | _optional_ | | Set the maximum request execution time. It is specified as a duration; for example, "10m5s" is ten minutes and five seconds. If you don't specify a unit, seconds is assumed. |
 | `no_traffic` | _optional_ | `false` | Set to `true` to avoid sending traffic to the revision being deployed.|
 | `revision_traffic` | _optional_ | | Comma separated list of traffic assignments in the form REVISION-NAME=PERCENTAGE. |
 | `tag_traffic` | _optional_ | | Comma separated list of traffic assignments in the form TAG=PERCENTAGE. |

action.yml

@@ -86,6 +86,13 @@ inputs:
       Traffic tag to assign to the newly created revision.
     required: false
 
+  timeout:
+    description: |-
+      Set the maximum request execution time. It is specified as a duration; for
+      example, "10m5s" is ten minutes and five seconds. If you don't specify a
+      unit, seconds is assumed.
+    required: false
+
   no_traffic:
     description: |-
       True to avoid sending traffic to the revision being deployed. Setting

dist/index.js

@@ -61,6 +61,7 @@ export async function run(): Promise<void> {
     const source = core.getInput('source'); // Source directory
     const suffix = core.getInput('suffix');
     const tag = core.getInput('tag');
+    const timeout = core.getInput('timeout');
     const noTraffic = core.getBooleanInput('no_traffic');
     const revTraffic = core.getInput('revision_traffic');
     const tagTraffic = core.getInput('tag_traffic');
@@ -121,11 +122,12 @@ export async function run(): Promise<void> {
         source,
       ];
       installBeta = true;
+      if (timeout) cmd.push('--timeout', timeout);
     } else if (metadata) {
       // Deploy service from metadata
-      if (image || name || envVars || secrets) {
+      if (image || name || envVars || secrets || timeout) {
         core.warning(
-          'Metadata YAML provided: ignoring `image`, `service`, `env_vars` and `secrets` inputs.',
+          `Metadata YAML provided, ignoring: "image", "service", "env_vars", "secrets", and "timeout" inputs.`,
         );
       }
       cmd = ['run', 'services', 'replace', metadata, '--platform', 'managed', '--region', region];
@@ -159,6 +161,7 @@ export async function run(): Promise<void> {
       if (suffix) cmd.push('--revision-suffix', suffix);
       if (noTraffic) cmd.push('--no-traffic');
     }
+    if (timeout) cmd.push('--timeout', timeout);
     // Add optional flags
     if (flags) {
       const flagList = parseFlags(flags);

src/deploy-cloudrun.ts

@@ -33,6 +33,7 @@ const fakeInputs: { [key: string]: string } = {
   source: '',
   suffix: '',
   tag: '',
+  timeout: '',
   revision_traffic: '',
   tag_traffic: '',
 };
@@ -56,7 +57,6 @@ describe('#deploy-cloudrun', function () {
         parseServiceAccountKey: sinon.stub(setupGcloud, 'parseServiceAccountKey'),
         isProjectIdSet: sinon.stub(setupGcloud, 'isProjectIdSet').resolves(true),
         installComponent: sinon.stub(setupGcloud, 'installComponent'),
-
         getExecOutput: sinon.stub(exec, 'getExecOutput'),
       };
     });
@@ -126,6 +126,14 @@ describe('#deploy-cloudrun', function () {
       await run();
       expect(this.stubs.installComponent.withArgs('beta').callCount).to.eq(1);
     });
+    it('sets timeout if given', async function () {
+      this.stubs.getInput.withArgs('timeout').returns('55m12s');
+      await run();
+      const call = this.stubs.getExecOutput.getCall(0);
+      expect(call).to.be;
+      const args = call.args[1];
+      expect(args).to.include.members(['--timeout', '55m12s']);
+    });
     it('installs beta components with tag', async function () {
       this.stubs.getInput.withArgs('tag').returns('test');
       await run();