From d724c5069f2ec1c7afed2739ca54d8f352601dfc Mon Sep 17 00:00:00 2001 From: Jess Bees Date: Tue, 19 Dec 2023 10:03:19 -0500 Subject: [PATCH 1/4] 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` | From b80d7fe30e71f47a58e6493cae0194c2e2fc50bf Mon Sep 17 00:00:00 2001 From: Jess Bees Date: Tue, 19 Dec 2023 11:27:25 -0500 Subject: [PATCH 2/4] Update README.md Co-authored-by: Tommy Byrd --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 37a93d3..bf1f86d 100644 --- a/README.md +++ b/README.md @@ -90,7 +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 | +| [`v4`](https://github.com/actions/deploy-pages/releases/tag/v4) | :information_source: TBD | | [`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` | From 925d92be20762ec0115ca5c1bf56370d7852083a Mon Sep 17 00:00:00 2001 From: Jess Bees Date: Tue, 19 Dec 2023 12:13:19 -0500 Subject: [PATCH 3/4] clarify actions permission --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bf1f86d..ae58ee9 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: @@ -76,7 +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: 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.) From 1a1c979b918da8156617ccf1449aeb21180693ba Mon Sep 17 00:00:00 2001 From: Jess Bees Date: Tue, 19 Dec 2023 12:15:02 -0500 Subject: [PATCH 4/4] clarify GHES compatibility --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ae58ee9..5eef130 100644 --- a/README.md +++ b/README.md @@ -91,7 +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) | :information_source: TBD | +| [`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` |