Merge pull request #16600 from github/workflow-should-run-on-label-events

Workflow should run on label events

Author: sarahs

.github/actions-scripts/enterprise-algolia-label.js

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+
+const fs = require('fs')
+const core = require('@actions/core')
+const eventPayload = JSON.parse(fs.readFileSync(process.env.GITHUB_EVENT_PATH, 'utf8'))
+
+// This workflow-run script does the following:
+// 1. Gets an array of labels on a PR.
+// 2. Finds one with the relevant Algolia text; if none found, exits early.
+// 3. Gets the version substring from the label string.
+
+const labelText = 'sync-english-index-for-'
+const labelsArray = eventPayload.pull_request.labels
+
+// Exit early if no labels are on this PR
+if (!(labelsArray && labelsArray.length)) {
+  process.exit(0)
+}
+
+// Find the relevant label
+const algoliaLabel = labelsArray
+  .map(label => label.name)
+  .find(label => label.startsWith(labelText))
+
+// Exit early if no relevant label is found
+if (!algoliaLabel) {
+  process.exit(0)
+}
+
+// Given: sync-english-index-for-enterprise-server@3.0
+// Returns: enterprise-server@3.0
+const versionToSync = algoliaLabel.split(labelText)[1]
+
+// Store the version so we can access it later in the workflow
+core.setOutput('versionToSync', versionToSync)
+process.exit(0)

.github/workflows/sync-single-english-algolia-index.yml

@@ -3,6 +3,8 @@ name: Algolia Sync Single English Index
 on:
   pull_request:
     types:
+      - labeled
+      - unlabeled
       - opened
       - reopened
       - synchronize
@@ -13,7 +15,7 @@ on:
 jobs:
   updateIndices:
     name: Update English index for single version based on a label's version
-    if: github.repository == 'github/docs-internal' && startsWith(github.event.label.name, 'sync-english-index-for-')
+    if: github.repository == 'github/docs-internal'
     runs-on: ubuntu-latest
     steps:
       - name: checkout
@@ -30,13 +32,13 @@ jobs:
             ${{ runner.os }}-node-
       - name: npm ci
         run: npm ci
-      - name: Get version from label
+      - name: Get version from Algolia label if present; only continue if the label is found.
         id: getVersion
-        run: |
-          echo "::set-output name=version::$(github.event.label.name.split('sync-english-index-for-')[1])"
-      - name: Sync English index for single version
+        run: $GITHUB_WORKSPACE/.github/actions-scripts/enterprise-algolia-label.js
+      - if: ${{ steps.getVersion.outputs.versionToSync }}
+        name: Sync English index for single version
         env:
-          VERSION: ${{ steps.getVersion.outputs.version }}
+          VERSION: ${{ steps.getVersion.outputs.versionToSync }}
           LANGUAGE: 'en'
           ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }}
           ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}

package.json

@@ -77,6 +77,7 @@
     "webpack-cli": "^3.3.12"
   },
   "devDependencies": {
+    "@actions/core": "^1.2.6",
     "ajv": "^6.11.0",
     "async": "^3.2.0",
     "await-sleep": "0.0.1",