From fb67d78c1852f2418b0dc07983c0339ab453bc34 Mon Sep 17 00:00:00 2001 From: "James M. Greene" Date: Mon, 15 May 2023 14:16:47 -0500 Subject: [PATCH 1/3] Add a compatibility table to the README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index a1488986..884cc394 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,21 @@ This action is used to deploy [Actions artifacts][artifacts] to [GitHub Pages](https://pages.github.com/). +## Compatibility + +This action is primarily design for use with GitHub.com's Actions workflows and Pages deployments. However, certain releases should also be compatible with GitHub Enterprise Server (GHES) `3.7` and above. + +| Release | GHES Compatibility | +|:---|:---| +| [`v2`](https://github.com/actions/deploy-pages/releases/tag/v2) | 🛑 Incompatible. Anticipating compatibility with `>= 3.9`. | +| [`v2.0.1`](https://github.com/actions/deploy-pages/releases/tag/v2.0.1) | 🛑 Incompatible. Anticipating compatibility with `>= 3.9`. | +| [`v2.0.0`](https://github.com/actions/deploy-pages/releases/tag/v2.0.0) | 🛑 Incompatible. Anticipating compatibility with `>= 3.9`. | +| [`v1`](https://github.com/actions/deploy-pages/releases/tag/v1) | `>= 3.7` | +| [`v1.2.8`](https://github.com/actions/deploy-pages/releases/tag/v1.2.8) | `>= 3.7` | +| [`v1.2.7`](https://github.com/actions/deploy-pages/releases/tag/v1.2.7) | :warning: [Incompatible](https://github.com/actions/deploy-pages/issues/137). Anticipating compatibility with `>= 3.9`. | +| [`v1.2.6`](https://github.com/actions/deploy-pages/releases/tag/v1.2.6) | `>= 3.7` | +| `v1.x.x` | `>= 3.7` | + ## Usage See [action.yml](action.yml) for the various `inputs` this action supports. From edaafab71f684318f9360c9dd6b0e97718563e21 Mon Sep 17 00:00:00 2001 From: "James M. Greene" Date: Mon, 15 May 2023 14:21:12 -0500 Subject: [PATCH 2/3] Add a compatibility note to the release notes generation template --- .github/release-drafter.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index 1b697bba..d65ecae3 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -7,6 +7,8 @@ template: | $CHANGES See details of [all code changes](https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION) since previous release. + + :warning: For use with products other than GitHub.com, such as GitHub Enterprise Server, please consult the [compatibility table](https://github.com/$OWNER/$REPOSITORY/#compatibilty). categories: - title: '🚀 Features' labels: From 668cc2675f1895f02e2afffb4f4be2f4b3136ce6 Mon Sep 17 00:00:00 2001 From: "James M. Greene" Date: Mon, 15 May 2023 14:29:46 -0500 Subject: [PATCH 3/3] Add a horizontal rule for a visual break --- .github/release-drafter.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index d65ecae3..4702473f 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -6,6 +6,8 @@ template: | $CHANGES + --- + See details of [all code changes](https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION) since previous release. :warning: For use with products other than GitHub.com, such as GitHub Enterprise Server, please consult the [compatibility table](https://github.com/$OWNER/$REPOSITORY/#compatibilty).