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

Update README to reflect v4

Browse Source 
* Changes version tag in sample code
* Adds newly required permission
* Notes that v4 isn't compatible with GHES yet
This commit is contained in:
Jess Bees
2023-12-19 10:03:19 -05:00
committed by GitHub
parent f33f41b675
commit d724c5069f
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -41,7 +41,7 @@ jobs:
steps: steps:
- name: Deploy to GitHub Pages - name: Deploy to GitHub Pages
id: deployment 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 📥 ### Inputs 📥
@@ -76,6 +76,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: 2. The job that executes the deployment must at minimum have the following permissions:
- `pages: write` - `pages: write`
- `id-token: write` - `id-token: write`
- `actions: write`
3. The deployment should target the `github-pages` environment (you may use a different environment name if needed, but this is not recommended.) 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 +90,7 @@ This action is primarily designed for use with GitHub.com's Actions workflows an
| Release | GHES Compatibility | | Release | GHES Compatibility |
|:---|:---| |:---|:---|
| [`v4`](https://github.com/actions/deploy-pages/releases/tag/v4) | :warning: none |
| [`v3`](https://github.com/actions/deploy-pages/releases/tag/v3) | `>= 3.9` | | [`v3`](https://github.com/actions/deploy-pages/releases/tag/v3) | `>= 3.9` |
| `v3.x.x` | `>= 3.9` | | `v3.x.x` | `>= 3.9` |
| [`v2`](https://github.com/actions/deploy-pages/releases/tag/v2) | `>= 3.9` | | [`v2`](https://github.com/actions/deploy-pages/releases/tag/v2) | `>= 3.9` |