actions/deploy-pages
1
0
Fork 0
mirror of https://github.com/actions/deploy-pages.git synced 2025-12-08 08:06:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' into use-artifacts-client

Browse Source
This commit is contained in:
James M. Greene
2023-12-20 10:57:21 -06:00
committed by GitHub
parent 81251b551f 47cf65bf47
commit af9eaca61c
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -30,6 +30,7 @@ jobs:
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
actions: read # to download an artifact uploaded by `actions/upload-pages-artifact@v3`
# Deploy to the github-pages environment
environment:
@@ -41,7 +42,7 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v3 # or specific "vX.X.X" version tag for this action
uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action
```
### Inputs 📥
@@ -76,6 +77,7 @@ There are a few important considerations to be aware of:
2. The job that executes the deployment must at minimum have the following permissions:
- `pages: write`
- `id-token: write`
- `actions: read`
3. The deployment should target the `github-pages` environment (you may use a different environment name if needed, but this is not recommended.)
@@ -89,6 +91,7 @@ This action is primarily designed for use with GitHub.com's Actions workflows an
| 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` |