set host header

Deprecate 'emit_telemetry' and remove its feature

.eslintignore

@@ -1,2 +0,0 @@
-node_modules/
-dist/

.eslintrc.json

@@ -1,19 +1,17 @@
 {
   "env": {
     "commonjs": true,
-    "es6": true,
+    "es2021": true,
-    "jest": true,
+    "node": true,
-    "node": true
+    "jest": true
-  },
-  "extends": "eslint:recommended",
-  "globals": {
-    "Atomics": "readonly",
-    "SharedArrayBuffer": "readonly"
   },
+  "plugins": ["github"],
+  "extends": ["eslint:recommended", "prettier", "plugin:github/internal"],
   "parserOptions": {
-    "ecmaVersion": 2018
+    "ecmaVersion": 12
   },
   "rules": {
     "semi": ["error", "never"]
-  }
+  },
+  "ignorePatterns": ["/dist/", "/pre/"]
 }

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# Default PR reviewers
+* @actions/pages

.github/release-drafter.yml

@@ -3,8 +3,10 @@ name-template: 'v$RESOLVED_VERSION'
 tag-template: 'v$RESOLVED_VERSION'
 template: |
   # Changelog
+
   $CHANGES
-  See details of [all code changes](https://github.com/actions/deploy-pages/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION) since previous release
+
+  See details of [all code changes](https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION) since previous release.
 categories:
   - title: '🚀 Features'
     labels:

.github/workflows/check-formatting.yml

@@ -0,0 +1,34 @@
+name: Checking formatting
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+
+# This allows a subsequently queued workflow run to interrupt previous runs
+concurrency:
+  group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Node.JS
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Verify formatting
+        run: npm run format:check

.github/workflows/check-linter.yml

@@ -0,0 +1,34 @@
+name: Check linter
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+
+# This allows a subsequently queued workflow run to interrupt previous runs
+concurrency:
+  group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Node.JS
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Verify linter
+        run: npm run lint:check

.github/workflows/codeql-analysis.yml

@@ -9,7 +9,7 @@
 # the `language` matrix defined below to confirm you have the correct set of
 # supported CodeQL languages.
 #
-name: "CodeQL"
+name: 'CodeQL'
 
 on:
   push:

.github/workflows/release.yml

@@ -1,7 +1,7 @@
-name: Release new action version
+name: Release
 on:
   release:
-    types: [edited]
+    types: [released]
   workflow_dispatch:
     inputs:
       TAG_NAME:
@@ -10,15 +10,17 @@ on:
 
 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
+    environment:
+      # Note: this environment is protected
+      name: Release
     steps:
       - name: Update the ${{ env.TAG_NAME }} tag
         id: update-major-tag

.prettierignore

@@ -1 +1,6 @@
-node_modules/
+# Ignore build artifacts
+/dist/
+/pre/
+
+# Ignore all Markdown files
+*.md

.prettierrc.json

@@ -1,10 +0,0 @@
-{
-  "printWidth": 80,
-  "tabWidth": 2,
-  "useTabs": false,
-  "semi": false,
-  "singleQuote": true,
-  "trailingComma": "none",
-  "bracketSpacing": false,
-  "arrowParens": "avoid"
-}

.prettierrc.yml

@@ -0,0 +1,10 @@
+# Prettier (formatter) configuration
+---
+printWidth: 120
+tabWidth: 2
+useTabs: false
+semi: false
+singleQuote: true
+trailingComma: none
+bracketSpacing: true
+arrowParens: avoid

README.md

@@ -1,4 +1,4 @@
-# Deploy-Pages
+# deploy-pages
 
 This action is used to deploy [Actions artifacts][artifacts] to GitHub Pages.
 
@@ -62,6 +62,18 @@ There are a few important considerations to be aware of:
 
 5. If your Pages site is using GitHub Actions as the source, while not required we highly recommend you also [protect your environment][environment-protection] (we do it by default for you)
 
+# Release instructions
+
+In order to release a new version of this Action:
+
+1. Locate the semantic version of the [upcoming release][release-list] (a draft is maintained by the [`draft-release` workflow][draft-release]).
+
+2. Publish the draft release from the `main` branch with semantic version as the tag name, _with_ the checkbox to publish to the GitHub Marketplace checked. :ballot_box_with_check:
+
+3. After publishing the release, the [`release` workflow][release] will automatically run to create/update the corresponding the major version tag such as `v1`.
+
+   ⚠️ Environment approval is required. Check the [Release workflow run list][release-workflow-runs].
+
 ## License
 
 The scripts and documentation in this project are released under the [MIT License](LICENSE).
@@ -71,3 +83,7 @@ The scripts and documentation in this project are released under the [MIT Licens
 [upload-pages-artifact]: https://github.com/actions/upload-pages-artifact
 [artifacts]: https://docs.github.com/en/actions/using-workflows/storing-workflow-data-as-artifacts
 [environment-protection]: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules
+[release-list]: https://github.com/actions/deploy-pages/releases
+[draft-release]: .github/workflows/draft-release.yml
+[release]: .github/workflows/release.yml
+[release-workflow-runs]: https://github.com/actions/deploy-pages/actions/workflows/release.yml

action.yml

@@ -1,13 +1,18 @@
-name: 'Deploy to GitHub Pages'
+name: 'Deploy GitHub Pages site'
-description: 'A GitHub Action to deploy an artifact to GitHub Pages'
+description: 'A GitHub Action to deploy an artifact as a GitHub Pages site'
+author: 'GitHub'
 runs:
   using: 'node16'
   main: 'dist/index.js'
 inputs:
   emit_telemetry:
+    deprecationMessage: 'Use of this input causes the action to do nothing. You should remove this build step from your workflow.'
     description: 'Should this action only emit build telemetry instead of deploying the build artifact?'
     required: false
-    default: "false"
+    default: 'false'
+  conclusion:
+    description: 'The status of the previous build.'
+    required: false
   token:
     description: 'GitHub token'
     default: ${{ github.token }}
@@ -15,19 +20,23 @@ inputs:
   timeout:
     description: 'Time in milliseconds after which to timeout and cancel the deployment (default: 10 minutes)'
     required: false
-    default: "600000"
+    default: '600000'
   error_count:
     description: 'Maximum number of status report errors before cancelling a deployment (default: 10)'
     required: false
-    default: "10"
+    default: '10'
   reporting_interval:
     description: 'Time in milliseconds between two deployment status report (default: 5 seconds)'
     required: false
-    default: "5000"
+    default: '5000'
   artifact_name:
     description: 'Name of the artifact to deploy'
     required: false
-    default: "github-pages"
+    default: 'github-pages'
+  preview:
+    description: 'Is this attempting to deploy a pull request as a GitHub Pages preview site? (NOTE: This feature is only in alpha currently and is not available to the public!)'
+    required: false
+    default: 'false'
 outputs:
   page_url:
     description: 'URL to deployed GitHub Pages'

babel.config.js

@@ -1 +0,0 @@
-module.exports = {presets: ['@babel/preset-env']}

dist/licenses.txt

@@ -35,32 +35,6 @@ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 
-@babel/runtime
-MIT
-MIT License
-
-Copyright (c) 2014-present Sebastian McKenzie and other contributors
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
 axios
 MIT
 Copyright (c) 2014-present Matt Zabriskie
@@ -84,22 +58,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
 
-axios-retry
-Apache-2.0
-Copyright 2019 Softonic International S.A.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-
 debug
 MIT
 (The MIT License)
@@ -158,20 +116,6 @@ The above copyright notice and this permission notice shall be included in all c
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 
-is-retry-allowed
-MIT
-MIT License
-
-Copyright (c) Vsevolod Strukchinsky <floatdrop@gmail.com> (github.com/floatdrop)
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
 ms
 MIT
 The MIT License (MIT)
@@ -197,31 +141,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
 
-regenerator-runtime
-MIT
-MIT License
-
-Copyright (c) 2014-present, Facebook, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
-
 supports-color
 MIT
 MIT License
@@ -258,3 +177,16 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
+
+
+uuid
+MIT
+The MIT License (MIT)
+
+Copyright (c) 2010-2020 Robert Kieffer and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

jest.config.js

@@ -1,5 +0,0 @@
-module.exports = {
-  transform: {
-    '^.+\\.(js|jsx)$': 'babel-jest'
-  }
-}

package.json

@@ -4,17 +4,11 @@
   "description": "Deploy an actions artifact to GitHub Pages",
   "main": "./dist/index.js",
   "dependencies": {
-    "@actions/artifact": "^0.5.2",
+    "@actions/core": "^1.10.0",
-    "@actions/core": "^1.6.0",
-    "@babel/plugin-transform-runtime": "^7.16.0",
     "axios": "^0.24.0",
-    "regenerator-runtime": "^0.13.9",
+    "axios-retry": "^3.2.4"
-    "axios-retry": "^3.2.4",
-    "tar": "^6.1.11"
   },
   "devDependencies": {
-    "@babel/preset-env": "^7.16.0",
-    "@github/prettier-config": "0.0.4",
     "@vercel/ncc": "^0.31.1",
     "eslint": "^8.2.0",
     "eslint-config-prettier": "^8.3.0",
@@ -24,14 +18,17 @@
     "prettier": "^2.4.1"
   },
   "scripts": {
-    "lint": "eslint src",
+    "all": "npm run format && npm run lint && npm run prepare && npm run test",
-    "prepare": "ncc build src/index.js -o dist --source-map --license licenses.txt && ncc build src/pre.js -o pre --source-map --license licenses.txt",
+    "format": "prettier --write .",
-    "test": "jest",
+    "format:check": "prettier --check .",
-    "all": "npm run lint && npm run prepare && npm run test"
+    "lint": "DEBUG=eslint:cli-engine eslint --fix .",
+    "lint:check": "DEBUG=eslint:cli-engine eslint .",
+    "prepare": "ncc build src/index.js -o dist --source-map --license licenses.txt",
+    "test": "jest"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/paper-spa/deploy-pages.git"
+    "url": "git+https://github.com/actions/deploy-pages.git"
   },
   "keywords": [
     "GitHub",
@@ -40,7 +37,7 @@
   "author": "GitHub",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/paper-spa/deploy-pages/issues"
+    "url": "https://github.com/actions/deploy-pages/issues"
   },
-  "homepage": "https://github.com/paper-spa/deploy-pages#readme"
+  "homepage": "https://github.com/actions/deploy-pages#readme"
 }

pre/licenses.txt

@@ -1,260 +0,0 @@
-@actions/core
-MIT
-The MIT License (MIT)
-
-Copyright 2019 GitHub
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-@actions/http-client
-MIT
-Actions Http Client for Node.js
-
-Copyright (c) GitHub, Inc.
-
-All rights reserved.
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
-associated documentation files (the "Software"), to deal in the Software without restriction,
-including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
-and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
-LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
-NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-@babel/runtime
-MIT
-MIT License
-
-Copyright (c) 2014-present Sebastian McKenzie and other contributors
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-axios
-MIT
-Copyright (c) 2014-present Matt Zabriskie
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-
-
-axios-retry
-Apache-2.0
-Copyright 2019 Softonic International S.A.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-
-debug
-MIT
-(The MIT License)
-
-Copyright (c) 2014 TJ Holowaychuk <tj@vision-media.ca>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software 
-and associated documentation files (the 'Software'), to deal in the Software without restriction, 
-including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, 
-and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial 
-portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT 
-LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-
-follow-redirects
-MIT
-Copyright 2014–present Olivier Lalonde <olalonde@gmail.com>, James Talmage <james@talmage.io>, Ruben Verborgh
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-of the Software, and to permit persons to whom the Software is furnished to do
-so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
-IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-has-flag
-MIT
-MIT License
-
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-is-retry-allowed
-MIT
-MIT License
-
-Copyright (c) Vsevolod Strukchinsky <floatdrop@gmail.com> (github.com/floatdrop)
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-ms
-MIT
-The MIT License (MIT)
-
-Copyright (c) 2016 Zeit, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
-
-regenerator-runtime
-MIT
-MIT License
-
-Copyright (c) 2014-present, Facebook, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
-
-supports-color
-MIT
-MIT License
-
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-tunnel
-MIT
-The MIT License (MIT)
-
-Copyright (c) 2012 Koichi Kobayashi
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

src/context.js

@@ -11,8 +11,9 @@ function getRequiredVars() {
     buildActor: process.env.GITHUB_ACTOR,
     actionsId: process.env.GITHUB_ACTION,
     githubToken: core.getInput('token'),
-    githubApiUrl: process.env.GITHUB_API_URL ?? 'https://api.github.com',
+    githubApiUrl: process.env.GITHUB_API_CUSTOM_URL ?? process.env.GITHUB_API_URL ?? 'https://api.github.com',
-    artifactName: core.getInput('artifact_name') ?? 'github-pages'
+    artifactName: core.getInput('artifact_name') ?? 'github-pages',
+    isPreview: core.getInput('preview') === 'true'
   }
 }
 

src/deployment.js

@@ -1,5 +1,3 @@
-require('regenerator-runtime/runtime')
-
 const core = require('@actions/core')
 const axios = require('axios')
 
@@ -7,9 +5,9 @@ const axios = require('axios')
 const getContext = require('./context')
 
 const errorStatus = {
-  'unknown_status' : 'Unable to get deployment status.',
+  unknown_status: 'Unable to get deployment status.',
-  'not_found' :  'Deployment not found.',
+  not_found: 'Deployment not found.',
-  'deployment_attempt_error' : 'Deployment temporarily failed, a retry will be automatically scheduled...'
+  deployment_attempt_error: 'Deployment temporarily failed, a retry will be automatically scheduled...'
 }
 
 class Deployment {
@@ -27,6 +25,7 @@ class Deployment {
     this.deploymentInfo = null
     this.githubApiUrl = context.githubApiUrl
     this.artifactName = context.artifactName
+    this.isPreview = context.isPreview === true
   }
 
   // Ask the runtime for the unsigned artifact URL and deploy to GitHub Pages
@@ -47,7 +46,9 @@ class Deployment {
       core.info(JSON.stringify(data))
       const artifactRawUrl = data?.value?.find(artifact => artifact.name === this.artifactName)?.url
       if (!artifactRawUrl) {
-            throw new Error('No uploaded artifact was found! Please check if there are any errors at build step, or uploaded artifact name is correct.')
+        throw new Error(
+          'No uploaded artifact was found! Please check if there are any errors at build step, or uploaded artifact name is correct.'
+        )
       }
 
       const artifactUrl = `${artifactRawUrl}&%24expand=SignedContent`
@@ -56,12 +57,18 @@ class Deployment {
         pages_build_version: this.buildVersion,
         oidc_token: idToken
       }
+      if (this.isPreview === true) {
+        payload.preview = true
+      }
       core.info(`Creating deployment with payload:\n${JSON.stringify(payload, null, '\t')}`)
+      core.info(`Sending payload to: ${pagesDeployEndpoint}`)
+      core.info(`It should be sent do: ${process.env.GITHUB_API_CUSTOM_URL}`)
       const response = await axios.post(pagesDeployEndpoint, payload, {
         headers: {
           Accept: 'application/vnd.github.v3+json',
           Authorization: `Bearer ${this.githubToken}`,
-            'Content-type': 'application/json'
+          'Content-type': 'application/json',
+          Host: 'api.github.com'
         }
       })
       this.requestedDeployment = true
@@ -71,7 +78,6 @@ class Deployment {
         this.deploymentInfo = response.data
       }
     } catch (error) {
-
       core.info(error.stack)
 
       // output raw error in debug mode.
@@ -81,20 +87,18 @@ class Deployment {
       if (error.response) {
         let errorMessage = `Failed to create deployment (status: ${error.response.status}) with build version ${this.buildVersion}. `
         if (error.response.status == 400) {
-            let message = ""
+          let message = ''
           if (error.response.data && error.response.data.message) {
             message = error.response.data.message
           } else {
             message = error.response.data
           }
           errorMessage += `Responded with: ${message}`
-          }
+        } else if (error.response.status == 403) {
-          else if (error.response.status == 403) {
           errorMessage += `Ensure GITHUB_TOKEN has permission "pages: write".`
         } else if (error.response.status == 404) {
           errorMessage += `Ensure GitHub Pages has been enabled.`
-          }
+        } else if (error.response.status >= 500) {
-          else if (error.response.status >= 500) {
           errorMessage += `Server error, is githubstatus.com reporting a Pages outage? Please re-run the deployment at a later time.`
         }
         throw errorMessage
@@ -107,10 +111,16 @@ class Deployment {
   // Poll the deployment endpoint for status
   async check() {
     try {
-        const statusUrl = this.deploymentInfo != null ?
+      const statusUrl =
-          this.deploymentInfo["status_url"] :
+        this.deploymentInfo != null
-          `${this.githubApiUrl}/repos/${this.repositoryNwo}/pages/deployment/status/${process.env['GITHUB_SHA']}`
+          ? this.deploymentInfo['status_url']
-        core.setOutput('page_url', this.deploymentInfo != null ? this.deploymentInfo["page_url"] : "")
+          : `${this.githubApiUrl}/repos/${this.repositoryNwo}/pages/deployment/status/${this.buildVersion}`
+      let pageUrl = this.deploymentInfo != null ? this.deploymentInfo['page_url'] : ''
+      const previewUrl = this.deploymentInfo != null ? this.deploymentInfo['preview_url'] : ''
+      if (this.isPreview && previewUrl) {
+        pageUrl = previewUrl
+      }
+      core.setOutput('page_url', pageUrl)
       const timeout = Number(core.getInput('timeout'))
       const reportingInterval = Number(core.getInput('reporting_interval'))
       const maxErrorCount = Number(core.getInput('error_count'))
@@ -142,7 +152,9 @@ class Deployment {
           break
         } else if (res.data.status == 'deployment_content_failed') {
           // The uploaded artifact is invalid.
-            core.setFailed('Artifact could not be deployed. Please ensure the content does not contain any hard links, symlinks and total size is less than 10GB.')
+          core.setFailed(
+            'Artifact could not be deployed. Please ensure the content does not contain any hard links, symlinks and total size is less than 10GB.'
+          )
           break
         } else if (errorStatus[res.data.status]) {
           // A temporary error happened, will query the status again
@@ -156,7 +168,7 @@ class Deployment {
 
           // set the Maximum error reporting interval greater than 15 sec but below 30 sec.
           if (errorReportingInterval < 1000 * 15) {
-              errorReportingInterval = errorReportingInterval << 1 | 1
+            errorReportingInterval = (errorReportingInterval << 1) | 1
           }
         } else {
           // reset the error reporting interval once get the proper status back.
@@ -166,13 +178,19 @@ class Deployment {
         if (errorCount >= maxErrorCount) {
           core.info('Too many errors, aborting!')
           core.setFailed('Failed with status code: ' + res.status)
-            break
+
+          // Explicitly cancel the deployment
+          await this.cancel()
+          return
         }
 
         // Handle timeout
         if (Date.now() - startTime >= timeout) {
           core.info('Timeout reached, aborting!')
           core.setFailed('Timeout reached, aborting!')
+
+          // Explicitly cancel the deployment
+          await this.cancel()
           return
         }
       }
@@ -183,5 +201,34 @@ class Deployment {
       }
     }
   }
+
+  async cancel() {
+    // Don't attemp to cancel if no deployment was created
+    if (!this.requestedDeployment) {
+      return
+    }
+
+    // Cancel the deployment
+    try {
+      const pagesCancelDeployEndpoint = `${this.githubApiUrl}/repos/${this.repositoryNwo}/pages/deployment/cancel/${this.buildVersion}`
+      await axios.put(
+        pagesCancelDeployEndpoint,
+        {},
+        {
+          headers: {
+            Accept: 'application/vnd.github.v3+json',
+            Authorization: `Bearer ${this.githubToken}`,
+            'Content-type': 'application/json'
+          }
+        }
+      )
+      core.info(`Deployment cancelled with ${pagesCancelDeployEndpoint}`)
+    } catch (error) {
+      core.setFailed(error)
+      if (error.response && error.response.data) {
+        core.info(JSON.stringify(error.response.data))
+      }
+    }
+  }
 }
 module.exports = { Deployment }

src/index.js

@@ -1,44 +1,20 @@
-require('regenerator-runtime/runtime')
-
 // This package assumes a site has already been built and the files exist in the current workspace
 // If there's an artifact named `artifact.tar`, it can upload that to actions on its own,
 // without the user having to do the tar process themselves.
 
 const core = require('@actions/core')
 // const github = require('@actions/github'); // TODO: Not used until we publish API endpoint to the @action/github package
-const axios = require('axios')
 
 const { Deployment } = require('./deployment')
 const deployment = new Deployment()
 
-// TODO: If the artifact hasn't been created, we can create it and upload to artifact storage ourselves
-// const tar = require('tar')
-
 async function cancelHandler(evtOrExitCodeOrError) {
-  try {
+  await deployment.cancel()
-    if (deployment.requestedDeployment) {
-      const pagesCancelDeployEndpoint = `${deployment.githubApiUrl}/repos/${process.env.GITHUB_REPOSITORY}/pages/deployment/cancel/${process.env.GITHUB_SHA}`
-      await axios.put(
-        pagesCancelDeployEndpoint,
-        {},
-        {
-          headers: {
-            Accept: 'application/vnd.github.v3+json',
-            Authorization: `Bearer ${deployment.githubToken}`,
-            'Content-type': 'application/json'
-          }
-        }
-      )
-      core.info(`Deployment cancelled with ${pagesCancelDeployEndpoint}`)
-    }
-  } catch (e) {
-    console.log('Deployment cancellation failed', e)
-  }
   process.exit(isNaN(+evtOrExitCodeOrError) ? 1 : +evtOrExitCodeOrError)
 }
 
 async function main() {
-  let idToken = ""
+  let idToken = ''
   try {
     idToken = await core.getIDToken()
   } catch (error) {
@@ -59,9 +35,9 @@ process.on('SIGINT', cancelHandler)
 process.on('SIGTERM', cancelHandler)
 
 // Main
-const emitTelemetry = core.getInput("emit_telemetry")
+const emitTelemetry = core.getInput('emit_telemetry')
-if (emitTelemetry === "true") {
+if (emitTelemetry === 'true') {
-  require('./pre')
+  // For compatibility, treat the use of this deprecated input as a no-op
 } else {
   main()
 }

src/index.test.js

@@ -5,8 +5,6 @@ const path = require('path')
 const nock = require('nock')
 const axios = require('axios')
 
-const { expect, jest } = require('@jest/globals')
-
 const { Deployment } = require('./deployment')
 
 describe('with all environment variables set', () => {
@@ -14,7 +12,7 @@ describe('with all environment variables set', () => {
     process.env.ACTIONS_RUNTIME_URL = 'my-url'
     process.env.GITHUB_RUN_ID = '123'
     process.env.ACTIONS_RUNTIME_TOKEN = 'a-token'
-    process.env.GITHUB_REPOSITORY = 'paper-spa/is-awesome'
+    process.env.GITHUB_REPOSITORY = 'actions/is-awesome'
     process.env.GITHUB_TOKEN = 'gha-token'
     process.env.GITHUB_SHA = '123abc'
     process.env.GITHUB_ACTOR = 'monalisa'
@@ -22,6 +20,11 @@ describe('with all environment variables set', () => {
     process.env.GITHUB_ACTION_PATH = 'something'
   })
 
+  afterEach(() => {
+    // Remove mock for `core.getInput('preview')`
+    delete process.env.INPUT_PREVIEW
+  })
+
   it('Executes cleanly', done => {
     const ip = path.join(__dirname, './index.js')
     cp.exec(`node ${ip}`, { env: process.env }, (err, stdout) => {
@@ -36,7 +39,7 @@ describe('with variables missing', () => {
     delete process.env.ACTIONS_RUNTIME_URL
     const ip = path.join(__dirname, './index.js')
     cp.exec(`node ${ip}`, { env: process.env }, (err, stdout) => {
-      expect(stdout).toBe("")
+      expect(stdout).toBe('')
       expect(err).toBeTruthy()
       expect(err.code).toBe(1)
       done()
@@ -49,7 +52,7 @@ describe('create', () => {
     process.env.ACTIONS_RUNTIME_URL = 'http://my-url/'
     process.env.GITHUB_RUN_ID = '123'
     process.env.ACTIONS_RUNTIME_TOKEN = 'a-token'
-    process.env.GITHUB_REPOSITORY = 'paper-spa/is-awesome'
+    process.env.GITHUB_REPOSITORY = 'actions/is-awesome'
     process.env.GITHUB_TOKEN = 'gha-token'
     process.env.GITHUB_SHA = '123abc'
     process.env.GITHUB_ACTOR = 'monalisa'
@@ -61,6 +64,8 @@ describe('create', () => {
           return 'github-pages'
         case 'token':
           return process.env.GITHUB_TOKEN
+        default:
+          return process.env[`INPUT_${param.toUpperCase()}`] || ''
       }
     })
 
@@ -80,10 +85,16 @@ describe('create', () => {
 
   it('can successfully create a deployment', async () => {
     process.env.GITHUB_SHA = 'valid-build-version'
-    const fakeJwt = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiNjllMWIxOC1jOGFiLTRhZGQtOGYxOC03MzVlMzVjZGJhZjAiLCJzdWIiOiJyZXBvOnBhcGVyLXNwYS9taW55aTplbnZpcm9ubWVudDpQcm9kdWN0aW9uIiwiYXVkIjoiaHR0cHM6Ly9naXRodWIuY29tL3BhcGVyLXNwYSIsInJlZiI6InJlZnMvaGVhZHMvbWFpbiIsInNoYSI6ImEyODU1MWJmODdiZDk3NTFiMzdiMmM0YjM3M2MxZjU3NjFmYWM2MjYiLCJyZXBvc2l0b3J5IjoicGFwZXItc3BhL21pbnlpIiwicmVwb3NpdG9yeV9vd25lciI6InBhcGVyLXNwYSIsInJ1bl9pZCI6IjE1NDY0NTkzNjQiLCJydW5fbnVtYmVyIjoiMzQiLCJydW5fYXR0ZW1wdCI6IjIiLCJhY3RvciI6IllpTXlzdHkiLCJ3b3JrZmxvdyI6IkNJIiwiaGVhZF9yZWYiOiIiLCJiYXNlX3JlZiI6IiIsImV2ZW50X25hbWUiOiJwdXNoIiwicmVmX3R5cGUiOiJicmFuY2giLCJlbnZpcm9ubWVudCI6IlByb2R1Y3Rpb24iLCJqb2Jfd29ya2Zsb3dfcmVmIjoicGFwZXItc3BhL21pbnlpLy5naXRodWIvd29ya2Zsb3dzL2JsYW5rLnltbEByZWZzL2hlYWRzL21haW4iLCJpc3MiOiJodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tIiwibmJmIjoxNjM4ODI4MDI4LCJleHAiOjE2Mzg4Mjg5MjgsImlhdCI6MTYzODgyODYyOH0.1wyupfxu1HGoTyIqatYg0hIxy2-0bMO-yVlmLSMuu2w'
+    const fakeJwt =
+      'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiNjllMWIxOC1jOGFiLTRhZGQtOGYxOC03MzVlMzVjZGJhZjAiLCJzdWIiOiJyZXBvOnBhcGVyLXNwYS9taW55aTplbnZpcm9ubWVudDpQcm9kdWN0aW9uIiwiYXVkIjoiaHR0cHM6Ly9naXRodWIuY29tL3BhcGVyLXNwYSIsInJlZiI6InJlZnMvaGVhZHMvbWFpbiIsInNoYSI6ImEyODU1MWJmODdiZDk3NTFiMzdiMmM0YjM3M2MxZjU3NjFmYWM2MjYiLCJyZXBvc2l0b3J5IjoicGFwZXItc3BhL21pbnlpIiwicmVwb3NpdG9yeV9vd25lciI6InBhcGVyLXNwYSIsInJ1bl9pZCI6IjE1NDY0NTkzNjQiLCJydW5fbnVtYmVyIjoiMzQiLCJydW5fYXR0ZW1wdCI6IjIiLCJhY3RvciI6IllpTXlzdHkiLCJ3b3JrZmxvdyI6IkNJIiwiaGVhZF9yZWYiOiIiLCJiYXNlX3JlZiI6IiIsImV2ZW50X25hbWUiOiJwdXNoIiwicmVmX3R5cGUiOiJicmFuY2giLCJlbnZpcm9ubWVudCI6IlByb2R1Y3Rpb24iLCJqb2Jfd29ya2Zsb3dfcmVmIjoicGFwZXItc3BhL21pbnlpLy5naXRodWIvd29ya2Zsb3dzL2JsYW5rLnltbEByZWZzL2hlYWRzL21haW4iLCJpc3MiOiJodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tIiwibmJmIjoxNjM4ODI4MDI4LCJleHAiOjE2Mzg4Mjg5MjgsImlhdCI6MTYzODgyODYyOH0.1wyupfxu1HGoTyIqatYg0hIxy2-0bMO-yVlmLSMuu2w'
     const scope = nock(`http://my-url`)
       .get('/_apis/pipelines/workflows/123/artifacts?api-version=6.0-preview')
-      .reply(200, { value: [ {url: 'https://another-artifact.com', name: 'another-artifact'}, { url: 'https://fake-artifact.com', name: 'github-pages' }] })
+      .reply(200, {
+        value: [
+          { url: 'https://another-artifact.com', name: 'another-artifact' },
+          { url: 'https://fake-artifact.com', name: 'github-pages' }
+        ]
+      })
 
     core.getIDToken = jest.fn().mockResolvedValue(fakeJwt)
     axios.post = jest.fn().mockResolvedValue('test')
@@ -93,7 +104,7 @@ describe('create', () => {
     await deployment.create(fakeJwt)
 
     expect(axios.post).toBeCalledWith(
-      'https://api.github.com/repos/paper-spa/is-awesome/pages/deployment',
+      'https://api.github.com/repos/actions/is-awesome/pages/deployment',
       {
         artifact_url: 'https://fake-artifact.com&%24expand=SignedContent',
         pages_build_version: 'valid-build-version',
@@ -109,10 +120,54 @@ describe('create', () => {
     )
 
     expect(core.setFailed).not.toHaveBeenCalled()
-    expect(core.info).toHaveBeenCalledWith(
+    expect(core.info).toHaveBeenCalledWith('Created deployment for valid-build-version')
-      'Created deployment for valid-build-version'
+
+    scope.done()
+  })
+
+  it('can successfully create a preview deployment', async () => {
+    process.env.GITHUB_SHA = 'valid-build-version'
+    const fakeJwt =
+      'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiNjllMWIxOC1jOGFiLTRhZGQtOGYxOC03MzVlMzVjZGJhZjAiLCJzdWIiOiJyZXBvOnBhcGVyLXNwYS9taW55aTplbnZpcm9ubWVudDpQcm9kdWN0aW9uIiwiYXVkIjoiaHR0cHM6Ly9naXRodWIuY29tL3BhcGVyLXNwYSIsInJlZiI6InJlZnMvaGVhZHMvbWFpbiIsInNoYSI6ImEyODU1MWJmODdiZDk3NTFiMzdiMmM0YjM3M2MxZjU3NjFmYWM2MjYiLCJyZXBvc2l0b3J5IjoicGFwZXItc3BhL21pbnlpIiwicmVwb3NpdG9yeV9vd25lciI6InBhcGVyLXNwYSIsInJ1bl9pZCI6IjE1NDY0NTkzNjQiLCJydW5fbnVtYmVyIjoiMzQiLCJydW5fYXR0ZW1wdCI6IjIiLCJhY3RvciI6IllpTXlzdHkiLCJ3b3JrZmxvdyI6IkNJIiwiaGVhZF9yZWYiOiIiLCJiYXNlX3JlZiI6IiIsImV2ZW50X25hbWUiOiJwdXNoIiwicmVmX3R5cGUiOiJicmFuY2giLCJlbnZpcm9ubWVudCI6IlByb2R1Y3Rpb24iLCJqb2Jfd29ya2Zsb3dfcmVmIjoicGFwZXItc3BhL21pbnlpLy5naXRodWIvd29ya2Zsb3dzL2JsYW5rLnltbEByZWZzL2hlYWRzL21haW4iLCJpc3MiOiJodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tIiwibmJmIjoxNjM4ODI4MDI4LCJleHAiOjE2Mzg4Mjg5MjgsImlhdCI6MTYzODgyODYyOH0.1wyupfxu1HGoTyIqatYg0hIxy2-0bMO-yVlmLSMuu2w'
+    const scope = nock(`http://my-url`)
+      .get('/_apis/pipelines/workflows/123/artifacts?api-version=6.0-preview')
+      .reply(200, {
+        value: [
+          { url: 'https://another-artifact.com', name: 'another-artifact' },
+          { url: 'https://fake-artifact.com', name: 'github-pages' }
+        ]
+      })
+
+    core.getIDToken = jest.fn().mockResolvedValue(fakeJwt)
+    axios.post = jest.fn().mockResolvedValue('test')
+
+    // Return `"true"` for `core.getInput("preview")`
+    process.env.INPUT_PREVIEW = 'true'
+
+    // Create the deployment
+    const deployment = new Deployment()
+    await deployment.create(fakeJwt)
+
+    expect(axios.post).toBeCalledWith(
+      'https://api.github.com/repos/actions/is-awesome/pages/deployment',
+      {
+        artifact_url: 'https://fake-artifact.com&%24expand=SignedContent',
+        pages_build_version: 'valid-build-version',
+        oidc_token: fakeJwt,
+        preview: true
+      },
+      {
+        headers: {
+          Accept: 'application/vnd.github.v3+json',
+          Authorization: `Bearer gha-token`,
+          'Content-type': 'application/json'
+        }
+      }
     )
 
+    expect(core.setFailed).not.toHaveBeenCalled()
+    expect(core.info).toHaveBeenCalledWith('Created deployment for valid-build-version')
+
     scope.done()
   })
 
@@ -131,9 +186,8 @@ describe('create', () => {
     try {
       deployment.create()
     } catch (err) {
-
       expect(axios.post).toBeCalledWith(
-        'https://api.github.com/repos/paper-spa/is-awesome/pages/deployment',
+        'https://api.github.com/repos/actions/is-awesome/pages/deployment',
         {
           artifact_url: 'https://invalid-artifact.com&%24expand=SignedContent',
           pages_build_version: 'invalid-build-version'
@@ -147,15 +201,12 @@ describe('create', () => {
         }
       )
 
-      expect(core.info).toHaveBeenLastCalledWith(
+      expect(core.info).toHaveBeenLastCalledWith('Failed to create deployment for invalid-build-version.')
-        'Failed to create deployment for invalid-build-version.'
-      )
       expect(core.setFailed).toHaveBeenCalledWith({ status: 400 })
 
       scope.done()
     }
   })
-
 })
 
 describe('check', () => {
@@ -163,7 +214,7 @@ describe('check', () => {
     process.env.ACTIONS_RUNTIME_URL = 'http://my-url/'
     process.env.GITHUB_RUN_ID = '123'
     process.env.ACTIONS_RUNTIME_TOKEN = 'a-token'
-    process.env.GITHUB_REPOSITORY = 'paper-spa/is-awesome'
+    process.env.GITHUB_REPOSITORY = 'actions/is-awesome'
     process.env.GITHUB_TOKEN = 'gha-token'
     process.env.GITHUB_SHA = '123abc'
     process.env.GITHUB_ACTOR = 'monalisa'

src/pre.js

@@ -1,57 +0,0 @@
-const core = require('@actions/core')
-const axios = require('axios')
-const axiosRetry = require('axios-retry')
-const retryAttempt = 3
-
-axiosRetry(axios, {
-  retries: retryAttempt,
-  retryDelay: retryCount => {
-    core.info(`retrying to send pages telemetry with attempt: ${retryCount}`)
-    return retryCount * 1000 // time interval between retries, with 1s, 2s, 3s
-  },
-
-  // retry on error greater than 500
-  retryCondition: error => {
-    return error.response.status >= 500
-  }
-})
-
-const {Deployment} = require('./deployment')
-
-async function emitTelemetry() {
-  // All variables we need from the runtime are set in the Deployment constructor
-  const deployment = new Deployment()
-  const telemetryUrl = `${deployment.githubApiUrl}/repos/${deployment.repositoryNwo}/pages/telemetry`
-  core.info(`Sending telemetry for run id ${deployment.workflowRun}`)
-  await axios
-    .post(
-      telemetryUrl,
-      {github_run_id: deployment.workflowRun},
-      {
-        headers: {
-          Accept: 'application/vnd.github.v3+json',
-          Authorization: `Bearer ${deployment.githubToken}`,
-          'Content-type': 'application/json'
-        }
-      }
-    )
-    .catch(err => {
-      if (err.response.status !== 200) {
-        throw new Error(
-          `failed to emit metric with status code: ${err.response.status} after ${retryAttempt} retry attempts`
-        )
-      }
-    })
-}
-
-async function main() {
-  try {
-    await emitTelemetry()
-  } catch (error) {
-    core.error('failed to emit pages build telemetry')
-  }
-}
-
-main()
-
-module.exports = {emitTelemetry}

src/pre.test.js

@@ -1,64 +0,0 @@
-const core = require('@actions/core')
-const process = require('process')
-const axios = require('axios')
-
-const {expect, jest} = require('@jest/globals')
-
-const {emitTelemetry} = require('./pre')
-
-describe('emitTelemetry', () => {
-  beforeAll(() => {
-    process.env.ACTIONS_RUNTIME_URL = 'my-url'
-    process.env.GITHUB_RUN_ID = '123'
-    process.env.ACTIONS_RUNTIME_TOKEN = 'a-token'
-    process.env.GITHUB_REPOSITORY = 'paper-spa/is-awesome'
-    process.env.GITHUB_TOKEN = 'gha-token'
-    process.env.GITHUB_SHA = '123abc'
-    process.env.GITHUB_ACTOR = 'monalisa'
-    process.env.GITHUB_ACTION = '__monalisa/octocat'
-    process.env.GITHUB_ACTION_PATH = 'something'
-
-    jest.spyOn(core, 'setOutput').mockImplementation(param => {
-      return param
-    })
-
-    jest.spyOn(core, 'setFailed').mockImplementation(param => {
-      return param
-    })
-    // Mock error/warning/info/debug
-    jest.spyOn(core, 'error').mockImplementation(jest.fn())
-    jest.spyOn(core, 'warning').mockImplementation(jest.fn())
-    jest.spyOn(core, 'info').mockImplementation(jest.fn())
-    jest.spyOn(core, 'debug').mockImplementation(jest.fn())
-  })
-
-  it('will send telemetry to github api', done => {
-    process.env.GITHUB_SHA = 'valid-build-version'
-
-    axios.post = jest.fn().mockResolvedValue({
-      status: 200,
-      data: {
-        status: 'succeed'
-      }
-    })
-
-    emitTelemetry()
-
-    expect(axios.post).toBeCalledWith(
-      'https://api.github.com/repos/paper-spa/is-awesome/pages/telemetry',
-      {
-        github_run_id: process.env.GITHUB_RUN_ID
-      },
-      {
-        headers: {
-          Accept: 'application/vnd.github.v3+json',
-          Authorization: 'Bearer ',
-          'Content-type': 'application/json'
-        }
-      }
-    )
-
-    expect(core.setFailed).not.toHaveBeenCalled()
-    done()
-  })
-})