Merge pull request #24 from actions/decouple-telemetry

Decouple telemetry API call from main action

.github/release-drafter.yml

@@ -0,0 +1,38 @@
+---
+name-template: 'v$RESOLVED_VERSION'
+tag-template: 'v$RESOLVED_VERSION'
+template: |
+  # Changelog
+  $CHANGES
+  See details of [all code changes](https://github.com/actions/jekyll-build-pages/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION) since previous release
+categories:
+  - title: '🚀 Features'
+    labels:
+      - 'feature'
+      - 'enhancement'
+  - title: '🐛 Bug Fixes'
+    labels:
+      - 'fix'
+      - 'bugfix'
+      - 'bug'
+  - title: '🧰 Maintenance'
+    labels:
+      - 'infrastructure'
+      - 'automation'
+      - 'documentation'
+  - title: '🏎 Performance'
+    label: 'performance'
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+version-resolver:
+  major:
+    labels:
+      - 'type: breaking'
+  minor:
+    labels:
+      - 'type: enhancement'
+  patch:
+    labels:
+      - 'type: bug'
+      - 'type: maintenance'
+      - 'type: documentation'
+  default: patch

.github/workflows/release-new-action-version.yml

@@ -0,0 +1,28 @@
+name: Release new action version
+on:
+  release:
+    types: [edited]
+  workflow_dispatch:
+    inputs:
+      TAG_NAME:
+        description: 'Tag name that the major tag will point to'
+        required: true
+
+env:
+  TAG_NAME: ${{ github.event.inputs.TAG_NAME || github.event.release.tag_name }}
+permissions:
+  contents: write
+
+jobs:
+  update_tag:
+    name: Update the major tag to include the ${{ github.event.inputs.TAG_NAME || github.event.release.tag_name }} changes
+    environment:
+      name: releaseNewActionVersion
+    runs-on: ubuntu-latest
+    steps:
+    - name: Update the ${{ env.TAG_NAME }} tag
+      id: update-major-tag
+      uses: actions/publish-action@v0.1.0
+      with:
+        source-tag: ${{ env.TAG_NAME }}
+        slack-webhook: ${{ secrets.SLACK_WEBHOOK }}

.github/workflows/test.yml

@@ -19,6 +19,10 @@ jobs:
 
     - name: Install dependencies
       run: npm install
-    
     - name: Run tests
       run: npm run test
+    # Drafts your next Release notes as Pull Requests are merged into "main"
+    - uses: release-drafter/release-drafter@v5
+      if: github.ref_name == 'main'
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

action.yml

@@ -3,8 +3,10 @@ description: 'A GitHub Action to deploy an artifact to GitHub Pages'
 runs:
   using: 'node16'
   main: 'dist/index.js'
-  pre: 'pre/index.js'
 inputs:
+  emit_telemetry:
+    description: 'Should this action only emit build telemetry instead of deploying the build artifact?'
+    required: false
   token:
     description: 'GitHub token'
     default: ${{ github.token }}
@@ -20,7 +22,7 @@ inputs:
   reporting_interval:
     description: 'Time in milliseconds between two deployment status report (default: 1 second)'
     required: false
-    default: "1000"
+    default: "5000"
 outputs:
   page_url:
     description: 'URL to deployed Github Pages'

dist/index.js

@@ -7125,9 +7125,9 @@ class Deployment {
           this.deploymentInfo["status_url"] :
           `https://api.github.com/repos/${this.repositoryNwo}/pages/deployment/status/${process.env['GITHUB_SHA']}`
         core.setOutput('page_url', this.deploymentInfo != null ? this.deploymentInfo["page_url"] : "")
-        const timeout = core.getInput('timeout')
+        const timeout = Number(core.getInput('timeout'))
         const reportingInterval = Number(core.getInput('reporting_interval'))
-        const maxErrorCount = core.getInput('error_count')
+        const maxErrorCount = Number(core.getInput('error_count'))
         var startTime = Date.now()
         var errorCount = 0
 
@@ -7182,12 +7182,13 @@ class Deployment {
             core.setFailed('Failed with status code: ' + res.status)
             break
           }
-        }
-        // Handle timeout
-        if (Date.now() - startTime >= timeout) {
-          core.info('Timeout reached, aborting!')
-          core.setFailed('Timeout reached, aborting!')
-          return
+
+          // Handle timeout
+          if (Date.now() - startTime >= timeout) {
+            core.info('Timeout reached, aborting!')
+            core.setFailed('Timeout reached, aborting!')
+            return
+          }
         }
       } catch (error) {
         core.setFailed(error)
@@ -7472,7 +7473,15 @@ process.on('SIGINT', cancelHandler)
 process.on('SIGTERM', cancelHandler)
 
 // Main
-main().then(() => __nccwpck_require__(9557))
+const emitTelemetry = core.getInput("emit_telemetry")
+if (emitTelemetry === "true") {
+  __nccwpck_require__(9557)
+} else if (emitTelemetry === "false") {
+  main()
+} else {
+  // If emit_telemetry is not set, that indicates an older version of the dynamic workflow that doesn't separate telemetry from deployment
+  main().then(() => __nccwpck_require__(9557))
+}
 
 })();
 

pre/index.js

@@ -7125,9 +7125,9 @@ class Deployment {
           this.deploymentInfo["status_url"] :
           `https://api.github.com/repos/${this.repositoryNwo}/pages/deployment/status/${process.env['GITHUB_SHA']}`
         core.setOutput('page_url', this.deploymentInfo != null ? this.deploymentInfo["page_url"] : "")
-        const timeout = core.getInput('timeout')
+        const timeout = Number(core.getInput('timeout'))
         const reportingInterval = Number(core.getInput('reporting_interval'))
-        const maxErrorCount = core.getInput('error_count')
+        const maxErrorCount = Number(core.getInput('error_count'))
         var startTime = Date.now()
         var errorCount = 0
 
@@ -7182,12 +7182,13 @@ class Deployment {
             core.setFailed('Failed with status code: ' + res.status)
             break
           }
-        }
-        // Handle timeout
-        if (Date.now() - startTime >= timeout) {
-          core.info('Timeout reached, aborting!')
-          core.setFailed('Timeout reached, aborting!')
-          return
+
+          // Handle timeout
+          if (Date.now() - startTime >= timeout) {
+            core.info('Timeout reached, aborting!')
+            core.setFailed('Timeout reached, aborting!')
+            return
+          }
         }
       } catch (error) {
         core.setFailed(error)

src/deployment.js

@@ -81,9 +81,9 @@ class Deployment {
           this.deploymentInfo["status_url"] :
           `https://api.github.com/repos/${this.repositoryNwo}/pages/deployment/status/${process.env['GITHUB_SHA']}`
         core.setOutput('page_url', this.deploymentInfo != null ? this.deploymentInfo["page_url"] : "")
-        const timeout = core.getInput('timeout')
+        const timeout = Number(core.getInput('timeout'))
         const reportingInterval = Number(core.getInput('reporting_interval'))
-        const maxErrorCount = core.getInput('error_count')
+        const maxErrorCount = Number(core.getInput('error_count'))
         var startTime = Date.now()
         var errorCount = 0
 
@@ -138,12 +138,13 @@ class Deployment {
             core.setFailed('Failed with status code: ' + res.status)
             break
           }
-        }
-        // Handle timeout
-        if (Date.now() - startTime >= timeout) {
-          core.info('Timeout reached, aborting!')
-          core.setFailed('Timeout reached, aborting!')
-          return
+
+          // Handle timeout
+          if (Date.now() - startTime >= timeout) {
+            core.info('Timeout reached, aborting!')
+            core.setFailed('Timeout reached, aborting!')
+            return
+          }
         }
       } catch (error) {
         core.setFailed(error)

src/index.js

@@ -52,4 +52,12 @@ process.on('SIGINT', cancelHandler)
 process.on('SIGTERM', cancelHandler)
 
 // Main
-main().then(() => require('./pre'))
+const emitTelemetry = core.getInput("emit_telemetry")
+if (emitTelemetry === "true") {
+  require('./pre')
+} else if (emitTelemetry === "false") {
+  main()
+} else {
+  // If emit_telemetry is not set, that indicates an older version of the dynamic workflow that doesn't separate telemetry from deployment
+  main().then(() => require('./pre'))
+}