diff --git a/docs/github-action.md b/docs/github-action.md index 624b773461..ad76b988cc 100644 --- a/docs/github-action.md +++ b/docs/github-action.md @@ -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" ] @@ -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). @@ -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 ] @@ -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.