Skip to content

Commit 4818ab2

Browse files
committed
Fix cron related documentation
Fix link to projects.csv in README.md Remove out of date info on daily cron job from CONTRIBUTING.md and fix various links. Signed-off-by: Arnaud J Le Hors <lehors@us.ibm.com>
1 parent 23523f6 commit 4818ab2

File tree

2 files changed

+8
-28
lines changed

2 files changed

+8
-28
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -117,30 +117,10 @@ The personal access token need the following scopes:
117117
1. See the [action files](.github/workflows) to check its tests, and the
118118
scripts used on it.
119119

120-
## dailyscore-cronjob
121-
122-
scorecard scans https://github.com/ossf/scorecard/blob/main/cron/projects.txt
123-
repositories in GCP k8s and publishes the results in GCS bucket
124-
`ossf-scorecards`.
125-
126-
The `cron` definition ./scorecard/cron/cron.sh and the `k8s` for the `cron` is
127-
in ./scorecard/cron/k8s/cron.yaml
128-
129-
The logs for the cron are available at
130-
https://console.cloud.google.com/kubernetes/cronjob/us-central1-c/openssf/default/daily-score/logs?project=openssf
131-
132-
### Deploying the cron job
133-
134-
The cronjob can be deployed into k8s by running `kubectl apply -f
135-
./scorecard/cron/k8s/cron.yaml`. This will deploy a k8s cron job.
136-
137-
Any updates to the ./scorecard/cron/cron.sh will be deployed by the docker
138-
container ./scorecard/Dockerfile.gsutil
139-
140-
## How do I add additional GitHub repositories to be scanned by scorecard dailyscore?
120+
## How do I add additional GitHub repositories to be scanned by scorecard weekly?
141121

142122
Scorecard maintains the list of repositories in a file
143-
https://github.com/ossf/scorecard/blob/main/cron/projects.txt
123+
https://github.com/ossf/scorecard/blob/main/cron/internal/data/projects.csv
144124

145125
Submit a PR for this file and scorecard would start scanning in subsequent runs.
146126

@@ -153,14 +133,14 @@ When you add new checks, you need to also update the docs.
153133

154134
A summary for each check needs to be included in the `README.md`.
155135
In most cases, to update the documentation simply edit the corresponding
156-
`.md` file, which the notable exception of the auto-generated file `checks.md`.
136+
`.md` file, with the notable exception of the auto-generated file `checks.md`.
157137

158-
Details about each check need to provided in
159-
`docs/checks/internal/checks.yaml`.
160-
If you want to update its documentation, updates that `checks.yaml` file.
138+
Details about each check need to be provided in
139+
[docs/checks/internal/checks.yaml](docs/checks/internal/checks.yaml).
140+
If you want to update its documentation, update that `checks.yaml` file.
161141

162142
Whenever you modify the `checks.yaml` file, run the following to
163-
generate `checks/checks.md`:
143+
generate `docs/checks.md`:
164144

165145
~~~~
166146
make generate-docs

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ bq extract --destination_format=NEWLINE_DELIMITED_JSON
109109
```
110110

111111
The list of projects that are checked is available in the
112-
[`cron/data/projects.csv`](https://github.com/ossf/scorecard/blob/main/cron/data/projects.csv)
112+
[`cron/internal/data/projects.csv`](https://github.com/ossf/scorecard/blob/main/cron/internal/data/projects.csv)
113113
file in this repository. If you would like us to track more, please feel free to
114114
send a Pull Request with others. Currently, this list is derived from **projects
115115
hosted on GitHub ONLY**. We do plan to expand them in near future to account for

0 commit comments

Comments
 (0)