Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📖 Add doc about SAML SSO #67

Merged
merged 8 commits into from
Jan 21, 2022
Merged

📖 Add doc about SAML SSO #67

Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c64dc93
add text
laurentsimon Jan 21, 2022
0a5c3ae
fix
laurentsimon Jan 21, 2022
bd933e2
updates
laurentsimon Jan 21, 2022
edeadf5
updates
laurentsimon Jan 21, 2022
b4d98ad
test
laurentsimon Jan 21, 2022
31abf41
test
laurentsimon Jan 21, 2022
048bd11
test
laurentsimon Jan 21, 2022
590728c
test
laurentsimon Jan 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ To install the Scorecards GitHub Action, you need to:

### Authentication
1. [Create a Personal Access Token](https://github.com/settings/tokens/new) with the following read permissions:
- Note: `Read-only token for OSSF Scorecard Action - myorg/myrepo` (Note: replace `myorg/myrepo` with the names of your organization and repository so you can keep track of your tokens.)
- Note 1: `Read-only token for OSSF Scorecard Action - myorg/myrepo` (Note: replace `myorg/myrepo` with the names of your organization and repository so you can keep track of your tokens.)
laurentsimon marked this conversation as resolved.
Show resolved Hide resolved
- Note 2: 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.
laurentsimon marked this conversation as resolved.
Show resolved Hide resolved
- Expiration: `No expiration`
- Scopes:
* `repo > public_repo`
Expand Down Expand Up @@ -88,6 +89,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
Expand Down