From d724c5069f2ec1c7afed2739ca54d8f352601dfc Mon Sep 17 00:00:00 2001 From: Jess Bees Date: Tue, 19 Dec 2023 10:03:19 -0500 Subject: [PATCH] Update README to reflect v4 * Changes version tag in sample code * Adds newly required permission * Notes that v4 isn't compatible with GHES yet --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7180f3f..37a93d3 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,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 +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: - `pages: 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.) @@ -89,6 +90,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: none | | [`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` |