Allow skipping default labels (#430)

Fixes #429

Author: sethvargo

.github/workflows/integration.yml

@@ -68,6 +68,7 @@ jobs:
         labels: |-
           label1=value1
           label2=value2
+        skip_default_labels: true
         flags: '--cpu=2 --concurrency=20'
 
     - run: 'npm run e2e-tests'
@@ -77,7 +78,7 @@ jobs:
         ENV: 'FOO=bar,ZIP=zap,TEXT_FOO=bar,TEXT_ZIP=zap'
         SECRET_ENV: MY_SECRET=${{ secrets.SECRET_NAME }}:latest,MY_SECOND_SECRET=${{ secrets.SECRET_NAME }}:1
         PARAMS: '{"cpu":2, "containerConcurrency":20}'
-        LABELS: '{"label1":"value1", "label2":"value2", "commit-sha":"${{ github.sha }}", "managed-by":"github-actions"}'
+        LABELS: '{"label1":"value1", "label2":"value2"}'
 
     - id: 'deploy-cloudrun-again'
       name: 'Deploy again'

README.md

@@ -141,17 +141,22 @@ jobs:
         my-label=my-value
     ```
 
-    The GitHub Action will automatically apply the following labels which Cloud
-    Run uses to enhance the user experience:
+    Labels have strict naming and casing requirements. See [Requirements for
+    labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+    for more information.
+
+-   `skip_default_labels`: (Optional) Skip applying the special annotation
+    labels that indicate the deployment came from GitHub Actions. The GitHub
+    Action will automatically apply the following labels which Cloud Run uses to
+    enhance the user experience:
 
     ```text
     managed-by: github-actions
     commit-sha: <sha>
     ```
 
-    Labels have strict naming and casing requirements. See [Requirements for
-    labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
-    for more information.
+    Setting this to `true` will skip adding these special labels. The default
+    value is `false`.
 
 -   `tag`: (Optional) Traffic tag to assign to the newly-created revision.
 

action.yml

@@ -67,6 +67,13 @@ inputs:
       KEY1=VALUE1,KEY2=VALUE2. Existing labels will be retained.
     required: false
 
+  skip_default_labels:
+    description: |-
+      Skip applying the special annotation labels that indicate the deployment
+      came from GitHub Actions.
+    required: false
+    default: false
+
   metadata:
     description: |-
       YAML service description for the Cloud Run service.

dist/main/index.js

@@ -30,6 +30,7 @@ import {
   errorMessage,
   isPinnedToHead,
   KVPair,
+  parseBoolean,
   parseFlags,
   parseKVString,
   parseKVStringAndFile,
@@ -104,6 +105,7 @@ export async function run(): Promise<void> {
     const revTraffic = getInput('revision_traffic');
     const tagTraffic = getInput('tag_traffic');
     const labels = parseKVString(getInput('labels'));
+    const skipDefaultLabels = parseBoolean(getInput('skip_default_labels'));
     const flags = getInput('flags');
 
     let responseType = ResponseTypes.DEPLOY; // Default response type for output parsing
@@ -201,8 +203,11 @@ export async function run(): Promise<void> {
       if (timeout) cmd.push('--timeout', timeout);
 
       // Compile the labels
-      const compiledLabels = Object.assign({}, defaultLabels(), labels);
-      cmd.push('--update-labels', kvToString(compiledLabels));
+      const defLabels = skipDefaultLabels ? {} : defaultLabels();
+      const compiledLabels = Object.assign({}, defLabels, labels);
+      if (compiledLabels && Object.keys(compiledLabels).length > 0) {
+        cmd.push('--update-labels', kvToString(compiledLabels));
+      }
     }
 
     // Push common flags

src/main.ts

@@ -35,6 +35,7 @@ const fakeInputs: { [key: string]: string } = {
   env_vars: '',
   env_vars_file: '',
   labels: '',
+  skip_default_labels: 'false',
   source: '',
   suffix: '',
   tag: '',
@@ -125,6 +126,22 @@ describe('#run', function () {
     expect(args).to.include.members(['--update-labels', kvToString(expectedLabels)]);
   });
 
+  it('skips default labels', async function () {
+    this.stubs.getInput.withArgs('skip_default_labels').returns('true');
+    this.stubs.getInput.withArgs('labels').returns('foo=bar,zip=zap');
+
+    const expectedLabels = {
+      foo: 'bar',
+      zip: 'zap',
+    };
+
+    await run();
+    const call = this.stubs.getExecOutput.getCall(0);
+    expect(call).to.be;
+    const args = call.args[1];
+    expect(args).to.include.members(['--update-labels', kvToString(expectedLabels)]);
+  });
+
   it('overwrites default labels', async function () {
     this.stubs.getInput.withArgs('labels').returns('commit-sha=custom-value');