From 14718fa5112a9954b45173d26205baa04ad85f0f Mon Sep 17 00:00:00 2001 From: Hayley Denbraver Date: Tue, 19 Sep 2023 17:55:55 +0000 Subject: [PATCH] updating based on testing Signed-off-by: Hayley Denbraver --- docs/github-action.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/github-action.md b/docs/github-action.md index 629c1a9aa5..88d8e7d08a 100644 --- a/docs/github-action.md +++ b/docs/github-action.md @@ -43,6 +43,7 @@ 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). @@ -77,4 +78,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.