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.

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

Installation docs update #1416

Merged
merged 14 commits into from
Jul 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
30 changes: 20 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,25 +48,35 @@ GitHub Enterprise repositories are not supported.
## Installation

### Workflow Setup (Required)
1) From your GitHub project's main page, click “Security” in the top ribbon.
1. From your GitHub project's main page, click “Security” in the top ribbon.

![image](/images/install01.png)
![image](/images/install01.png)

2) Select “Code scanning”.
2. Select “Code scanning”.

![image](/images/install02.png)
![image](/images/install02.png)

3) Then click "Add tool".
3. Depending on whether the repository already has a scanning tool configured, you will see "Add tool" or "Configure scanning tool.

![image](/images/install03.png)
a. If you see "Add tool" click it and skip step `b`.

4) Choose the "OSSF Scorecard" from the list of workflows, and then click “Configure”.
![image](/images/install03.png)

![image](/images/install04.png)
If you see "Configure scanning tool" proceed to step `b`:

5) Commit the changes.
![image](/images/configurescantool.png)

![image](/images/install05.png)
b. After clicking "Configure scanning tool", click "Explore workflows" underneath the "Other tools" section:

![image](/images/exploreworkflow.png)

5. Choose the "OSSF Scorecard" from the list of workflows below, and then click “Configure”. (To find it faster type "OSSF" in searchbox.)

![image](/images/searchingossf.png)

6. Commit the changes. (Your button might say "Commit changes..." instead of "Start commit", it does the same thing.)

![image](/images/install05.png)

### Authentication with Fine-grained PAT (optional)
Scorecard can run successfully with the workflow's default `GITHUB_TOKEN`, which is our recommended approach.
Expand Down
Binary file added images/configurescantool.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/exploreworkflow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/install04.png
Binary file not shown.
Binary file added images/searchingossf.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading