From 2f01b56a0e62e1b60878dd65d1f9a161640ca09a Mon Sep 17 00:00:00 2001 From: laurentsimon <64505099+laurentsimon@users.noreply.github.com> Date: Fri, 21 Jan 2022 14:35:22 -0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=96=20Add=20doc=20about=20SAML=20SSO?= =?UTF-8?q?=20(#67)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * add text * fix * updates * updates * test * test * test * test --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7febd830..34631345 100644 --- a/README.md +++ b/README.md @@ -40,13 +40,15 @@ To install the Scorecards GitHub Action, you need to: * `write:discussion > read:discussion` ![image](/images/tokenscopes.png) - + 2. Copy the token value. 3. [Create a new repository secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) with the following settings: - Name: `SCORECARD_READ_TOKEN` - Value: the value of the token created in step 1 above. +4. (Optional) If you install Scorecard on a repository owned by an organization that uses [SAML SSO](https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on), be sure to [enable SSO](https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on) for your PAT token. + ### Workflow Setup 1) From your GitHub project's main page, click “Security” in the top ribbon. @@ -88,6 +90,8 @@ To verify that the Action is running successfully, click the repository's Action ### Troubleshooting If the run has failed, the most likely reason is an authentication failure. Confirm that the Personal Access Token is saved as an encrypted secret within the same repository (see [Authentication](#authentication)). +If you install Scorecard on a repository owned by an organization that uses [SAML SSO](https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on) or if you see `403 Resource protected by organization SAML enforcement` in the logs, be sure to [enable SSO](https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on) for your PAT token (see [Authentication](#authentication)). + If the PAT is saved as an encrypted secret and the run is still failing, confirm that you have not made any changes to the workflow yaml file that affected the syntax. Review the [workflow example](#workflow-example) and reset to the default values if necessary. ## Manual Action Setup