diff --git a/README.md b/README.md index 7180f3f..5eef130 100644 --- a/README.md +++ b/README.md @@ -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` |