Merge pull request #8 from github/snapshot-to-database

Rename snapshotPath to databasePath

Author: Sam Lanning

README.md

@@ -72,11 +72,9 @@ which details the configuration for the course.
 
 The file should look something like this:
 
-<!-- TODO : change snapshotPath to databasePath -->
-
 ```json
 {
-  "snapshotPath": "<path-to-database-directory>",
+  "databasePath": "<path-to-database-directory>",
   "locationPaths": "https://github.com/<owner>/<repo>/blob/<sha>{path}#L{line-start}-L{line-end}",
   "expectedResults": {
     "step-01.ql": "step-01.csv",
@@ -91,7 +89,7 @@ a course image needs to also add the snapshot directory
 that queries should be run against,
 and csv files for the expected results.
 
-* `snapshotPath` should be a directory in the docker image,
+* `databasePath` should be a directory in the docker image,
   relative to the `config.json` file,
   that contains the extracted CodeQL database that queries will be run against.
   If you are using the template below,

codeql-learninglab-check/package/src/index.ts

@@ -45,7 +45,7 @@ const CONFIG_JSON = path.join(CONFIG_PATH, 'config.json');
 const OUTPUT_PATH = path.join(CODEQL_HOME, 'output');
 
 type Config = {
-  snapshotPath: string;
+  databasePath: string;
   /**
    * If set, the locations of extra or missing results can be linked to from
    * comments. {path} and {line-start} placeholders need to be present
@@ -61,7 +61,7 @@ type Config = {
 function isConfig(config: any): config is Config {
   if (!config)
     throw new Error('Configuration not specified');
-  if (typeof config.snapshotPath !== 'string')
+  if (typeof config.databasePath !== 'string')
     throw new Error('Configuration must specify a valid snapshotPath');
   if (typeof config.expectedResults !== 'object')
     throw new Error('Configuration property expectedResults invalid');
@@ -299,7 +299,7 @@ function isConfig(config: any): config is Config {
     console.log(`- ${query}`);
 
   // Upgrade the database if neccesary
-  const databasePath = path.join(CONFIG_PATH, config.snapshotPath);
+  const databasePath = path.join(CONFIG_PATH, config.databasePath);
   console.log('Upgrading CodeQL Database');
   await execFile('codeql', ['database', 'upgrade', databasePath]);
 

codeql-learninglab-check/publish.sh

@@ -5,8 +5,8 @@ set -x
 
 docker login docker.pkg.github.com -u github-actions -p ${GITHUB_TOKEN}
 
-PREV_IMAGE_VERSION=v0.0.5
-IMAGE_VERSION=v0.0.6
+PREV_IMAGE_VERSION=v0.0.6
+IMAGE_VERSION=v0.0.7
 IMAGE_PATH=docker.pkg.github.com/github/codeql-learninglab-actions/codeql-learninglab-check
 IMAGE_TAG=${IMAGE_PATH}:${IMAGE_VERSION}