mirror: actions/deploy-pages@v4 (upstream d6db90164a)

Filtered minimal mirror — see /usr/local/bin/mol-mirror-action.sh.
Provenance: https://github.com/actions/deploy-pages.git@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e

.mol-mirror-source

@@ -1 +1 @@
-https://github.com/actions/deploy-pages.git@f27bcc15848fdcdcc02f01754eb838e44bcf389b@2026-05-10T14:07:14Z
+https://github.com/actions/deploy-pages.git@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e@2026-05-10T14:07:14Z

README.md

@@ -1,18 +1,16 @@
-# deploy-pages
+# deploy-pages 🚀
 
-This action is used to deploy [Actions artifacts][artifacts] to GitHub Pages.
+[![Release](https://img.shields.io/github/v/release/actions/deploy-pages?label=Release&logo=github)](https://github.com/actions/deploy-pages/releases/latest) [![Linting](https://img.shields.io/github/actions/workflow/status/actions/deploy-pages/check-linter.yml?label=Linting&logo=github)](https://github.com/actions/deploy-pages/actions/workflows/check-linter.yml) [![Formatting](https://img.shields.io/github/actions/workflow/status/actions/deploy-pages/check-formatting.yml?label=Formatting&logo=github)](https://github.com/actions/deploy-pages/actions/workflows/check-formatting.yml) [![Tests](https://img.shields.io/github/actions/workflow/status/actions/deploy-pages/test.yml?label=Tests&logo=github)](https://github.com/actions/deploy-pages/actions/workflows/test.yml) ![Coverage](./coverage_badge.svg) [![Distributables](https://img.shields.io/github/actions/workflow/status/actions/deploy-pages/check-dist.yml?label=Distributables&logo=github)](https://github.com/actions/deploy-pages/actions/workflows/check-dist.yml) [![CodeQL](https://img.shields.io/github/actions/workflow/status/actions/deploy-pages/codeql-analysis.yml?label=CodeQL&logo=github)](https://github.com/actions/deploy-pages/actions/workflows/codeql-analysis.yml)
 
-## Scope
-
-⚠️ Official support for building Pages with Actions is in public beta at the moment.
+This action is used to deploy [Actions artifacts][artifacts] to [GitHub Pages](https://pages.github.com/).
 
 ## Usage
 
-See [action.yml](action.yml) for the various `inputs` this action supports.
+See [action.yml](action.yml) for the various `inputs` this action supports (or [below](#inputs-📥)).
 
 For examples that make use of this action, check out our [starter-workflows][starter-workflows] in a variety of frameworks.
 
-This action expects an artifact named `github-pages` to have been created prior to execution. This is done automatically using [`actions/upload-pages-artifact`][upload-pages-artifact].
+This action deploys a Pages site previously uploaded as an artifact (e.g. using [`actions/upload-pages-artifact`][upload-pages-artifact]).
 
 We recommend this action to be used in a dedicated job:
 
@@ -43,14 +41,37 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v1
+        uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action
 ```
 
-## Security considerations
+### Inputs 📥
+
+| Input | Required? | Default | Description |
+| ----- | --------- | ------- | ----------- |
+| `token` | `true` | `${{ github.token }}` | The GitHub token used to create an authenticated client - Provided for you by default! |
+| `timeout` | `false` | `"600000"` | Time in milliseconds after which to timeout and cancel the deployment (default: 10 minutes) |
+| `error_count` | `false` | `"10"` | Maximum number of status report errors before cancelling a deployment (default: 10) |
+| `reporting_interval` | `false` | `"5000"` | Time in milliseconds between two deployment status reports (default: 5 seconds) |
+| `artifact_name` | `false` | `"github-pages"` | The name of the artifact to deploy |
+| `preview` | `false` | `"false"` | 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!) |
+
+### Outputs 📤
+
+| Output | Description |
+| ------ | ----------- |
+| `page_url` | The URL of the deployed Pages site |
+
+### Environment Variables 🌎
+
+| Variable | Description |
+| -------- | ----------- |
+| `GITHUB_PAGES` | This environment variable is created and set to the string value `"true"` so that framework build tools may choose to differentiate their output based on the intended target hosting platform. |
+
+## Security Considerations
 
 There are a few important considerations to be aware of:
 
-1. The artifact being deployed must have been uploaded in a previous step, either in the same job or a separate job that doesn't execute until the upload is complete.
+1. The artifact being deployed must have been uploaded in a previous step, either in the same job or a separate job that doesn't execute until the upload is complete. See [`actions/upload-pages-artifact`][upload-pages-artifact] for more information about the format of the artifact we expect.
 
 2. The job that executes the deployment must at minimum have the following permissions:
    - `pages: write`
@@ -60,9 +81,26 @@ There are a few important considerations to be aware of:
 
 4. If your Pages site is using a source branch, the deployment must originate from this source branch unless [your environment is protected][environment-protection] in which case the environment protection rules take precedence over the source branch rule
 
-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)
+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 will configure it by default for you).
 
-# Release instructions
+## Compatibility
+
+This action is primarily designed for use with GitHub.com's Actions workflows and Pages deployments. However, certain releases should also be compatible with GitHub Enterprise Server (GHES) `3.7` and above.
+
+| Release | GHES Compatibility |
+|:---|:---|
+| [`v4`](https://github.com/actions/deploy-pages/releases/tag/v4) | :warning: Incompatible at this time |
+| [`v3`](https://github.com/actions/deploy-pages/releases/tag/v3) | `>= 3.9` |
+| `v3.x.x` | `>= 3.9` |
+| [`v2`](https://github.com/actions/deploy-pages/releases/tag/v2) | `>= 3.9` |
+| `v2.x.x` | `>= 3.9` |
+| [`v1`](https://github.com/actions/deploy-pages/releases/tag/v1) | `>= 3.7` |
+| [`v1.2.8`](https://github.com/actions/deploy-pages/releases/tag/v1.2.8) | `>= 3.7` |
+| [`v1.2.7`](https://github.com/actions/deploy-pages/releases/tag/v1.2.7) | :warning: `>= 3.9` [Incompatible with prior versions!](https://github.com/actions/deploy-pages/issues/137) |
+| [`v1.2.6`](https://github.com/actions/deploy-pages/releases/tag/v1.2.6) | `>= 3.7` |
+| `v1.x.x` | `>= 3.7` |
+
+## Release Instructions
 
 In order to release a new version of this Action:
 
@@ -70,7 +108,7 @@ In order to release a new version of this Action:
 
 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`.
+3. After publishing the release, the [`release` workflow][release] will automatically run to create/update the corresponding major version tag such as `v1`.
 
    ⚠️ Environment approval is required. Check the [Release workflow run list][release-workflow-runs].
 

action.yml

@@ -2,18 +2,9 @@ name: 'Deploy GitHub Pages site'
 description: 'A GitHub Action to deploy an artifact as a GitHub Pages site'
 author: 'GitHub'
 runs:
-  using: 'node16'
+  using: 'node20'
   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'
-  conclusion:
-    deprecationMessage: 'Use of this input does nothing as it was part of the deprecated `emit_telemetry` flow. You should remove this parameter from your workflow.'
-    description: 'The status of the previous build.'
-    required: false
   token:
     description: 'GitHub token'
     default: ${{ github.token }}

package.json

@@ -1,26 +1,29 @@
 {
   "name": "deploy-pages",
-  "version": "0.0.1",
+  "version": "0.0.0",
   "description": "Deploy an actions artifact to GitHub Pages",
   "main": "./dist/index.js",
   "dependencies": {
-    "@actions/core": "^1.10.0",
-    "@actions/github": "^5.1.1",
-    "@actions/http-client": "^2.1.0",
-    "@octokit/request-error": "^3.0.3",
+    "@actions/artifact": "^2.1.3",
+    "@actions/core": "^1.10.1",
+    "@actions/github": "^6.0.0",
+    "@octokit/request-error": "^5.0.1",
     "http-status-messages": "^1.1.0"
   },
   "devDependencies": {
-    "@vercel/ncc": "^0.31.1",
-    "eslint": "^8.36.0",
-    "eslint-config-prettier": "^8.7.0",
-    "eslint-plugin-github": "^4.6.1",
-    "jest": "^29.5.0",
-    "nock": "^13.3.0",
-    "prettier": "^2.8.4"
+    "@vercel/ncc": "^0.38.1",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-github": "^4.10.1",
+    "jest": "^29.7.0",
+    "make-coverage-badge": "^1.2.0",
+    "nock": "^13.5.3",
+    "prettier": "^3.2.5",
+    "undici": "^6.6.2"
   },
   "scripts": {
-    "all": "npm run format && npm run lint && npm run prepare && npm run test",
+    "all": "npm run format && npm run lint && npm run prepare && npm run test && npm run coverage-badge",
+    "coverage-badge": "make-coverage-badge --output-path ./coverage_badge.svg",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
     "lint": "DEBUG=eslint:cli-engine eslint --fix .",
@@ -41,5 +44,22 @@
   "bugs": {
     "url": "https://github.com/actions/deploy-pages/issues"
   },
-  "homepage": "https://github.com/actions/deploy-pages#readme"
+  "homepage": "https://github.com/actions/deploy-pages#readme",
+  "jest": {
+    "coverageReporters": [
+      "json-summary",
+      "text",
+      "lcov"
+    ],
+    "collectCoverage": true,
+    "collectCoverageFrom": [
+      "./src/**"
+    ],
+    "coverageThreshold": {
+      "global": {
+        "lines": 70,
+        "statements": 70
+      }
+    }
+  }
 }