From 0e32a1377520da6a3d18625b0a0cac69b916635e Mon Sep 17 00:00:00 2001 From: peterwoodworth Date: Fri, 18 Aug 2023 16:19:17 -0700 Subject: [PATCH] chore: update readme --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 8ea1f7f..aa5c903 100644 --- a/README.md +++ b/README.md @@ -107,6 +107,12 @@ jobs: See [action.yml](action.yml) for the full documentation for this action's inputs and outputs. +### Note about GHES + +Some of this documentation may be inaccurate if you are using GHES (GitHub Enterprise Servers), please take note to review the GitHub documentation when relevant. + +For example, the URL that the OIDC JWT is issued from is different than the usual `tokens.actions.githubusercontent.com`, and will be unique to your enterprise server. As a result, you will need to configure this differently when you create the Identity Provider. + ## Security recommendations We recommend following