Skip to content

Commit

Permalink
Installation docs update (#1416)
Browse files Browse the repository at this point in the history
* Update README.md

Modified texts for steps 3-4

Signed-off-by: Jeremiah Howard <[email protected]>

* Added Install Instruction Screenshots

Capturing screenshots of the installation instructions of OSSF Scorecard

Signed-off-by: Jeremiah Howard <[email protected]>

* Delete images/configureScanningToolSS.png

Signed-off-by: Jeremiah Howard <[email protected]>

* Delete images/exploreWorkflowsSS.png

Signed-off-by: Jeremiah Howard <[email protected]>

* Delete images/searchingOSSF.png

Signed-off-by: Jeremiah Howard <[email protected]>

* Add files via upload

Signed-off-by: Jeremiah Howard <[email protected]>

* Updating the installation instructions 

Updated screenshots of the installation instructions, and added extra detailed steps. 

Co-authored-by: Silas Morgan <[email protected]> 
Co-authored-by: Kemon Bynum <[email protected]>
Co-authored-by: Jordin Jones <[email protected]>
Co-authored-by: Elijah Everett <[email protected]>
Co-authored-by: Emily Lovell <[email protected]>

Signed-off-by: Jeremiah Howard <[email protected]>

* Delete images/install04.png

Signed-off-by: Jeremiah Howard <[email protected]>

* Rename configureScanningToolSS.png to configurescantool.png

Signed-off-by: Jeremiah Howard <[email protected]>

* Rename exploreWorkflowsSS.png to exploreworkflow.png

Signed-off-by: Jeremiah Howard <[email protected]>

* Rename searchingOSSF.png to searchingossf.png

Signed-off-by: Jeremiah Howard <[email protected]>

* Incorporated suggested phrasing

Signed-off-by: Jeremiah Howard <[email protected]>

* Fixed numbering and indentation 

Signed-off-by: Jeremiah Howard <[email protected]>

---------

Signed-off-by: Jeremiah Howard <[email protected]>
  • Loading branch information
JeremiahAHoward authored Jul 31, 2024
1 parent 62b2cac commit da91232
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 10 deletions.
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.

0 comments on commit da91232

Please sign in to comment.