Skip to content
This repository was archived by the owner on Sep 1, 2022. It is now read-only.

Commit f028684

Browse files
committed
Update README to reflect change to config
1 parent 7e0916e commit f028684

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,9 @@ which details the configuration for the course.
7272

7373
The file should look something like this:
7474

75-
<!-- TODO : change snapshotPath to databasePath -->
76-
7775
```json
7876
{
79-
"snapshotPath": "<path-to-database-directory>",
77+
"databasePath": "<path-to-database-directory>",
8078
"locationPaths": "https://github.com/<owner>/<repo>/blob/<sha>{path}#L{line-start}-L{line-end}",
8179
"expectedResults": {
8280
"step-01.ql": "step-01.csv",
@@ -91,7 +89,7 @@ a course image needs to also add the snapshot directory
9189
that queries should be run against,
9290
and csv files for the expected results.
9391

94-
* `snapshotPath` should be a directory in the docker image,
92+
* `databasePath` should be a directory in the docker image,
9593
relative to the `config.json` file,
9694
that contains the extracted CodeQL database that queries will be run against.
9795
If you are using the template below,

0 commit comments

Comments
 (0)