Skip to content

Commit

Permalink
addressing comments
Browse files Browse the repository at this point in the history
Signed-off-by: Hayley Denbraver <[email protected]>
  • Loading branch information
Hayley Denbraver committed Sep 21, 2023
1 parent bbe6ce6 commit b330bdf
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/github-action.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ name: OSV-Scanner Scheduled Scan
on:
schedule:
- cron: '12 12 * * 1'
# Change "main" to your default branch if you use a different name, i.e. "master"
push:
branches: [ "main" ]

Expand All @@ -43,7 +44,6 @@ jobs:
scan-scheduled:
uses: "google/osv-scanner/.github/workflows/osv-scanner-reusable-scheduled.yml@main"
```
The above code assumes that your primary branch is called `main`, if you use another name, like `master`, you will need to update the file to correspond with your primary branch name.
As written, the scanner will run on 12:12 pm UTC every Monday. You can change the schedule by following the instructions [here](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule).
Expand All @@ -64,6 +64,7 @@ Include the following in the [`osv-scanner-pr.yml`](https://github.com/google/os
```yml
name: OSV-Scanner PR Scan
# Change "main" to your default branch if you use a different name, i.e. "master"
on:
pull_request:
branches: [ main ]
Expand All @@ -78,8 +79,8 @@ jobs:
uses: "google/osv-scanner/.github/workflows/osv-scanner-reusable-pr.yml@main"
```

The above code assumes that your primary branch is called `main`, if you use another name, like `master`, you will need to update the file to correspond with your primary branch name.

### View results

Results may be viewed by clicking on the details of the failed action, either from your project's actions tab or directly on the PR.
Results may be viewed by clicking on the details of the failed action, either from your project's actions tab or directly on the PR. Results are also included in GitHub annotations on the "Files changed" tab for the PR.

Results are also available to maintainers by navigating to their project's security > code scanning tab.

0 comments on commit b330bdf

Please sign in to comment.