hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-17 01:03:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #11473 from github/d10c-preparedbupgrade-md

Browse Source 
Update docs/prepare-db-upgrade.md
This commit is contained in:
Nora Dimitrijević
2022-11-29 15:27:58 +01:00
committed by GitHub
parent 5bcb9b285a 1ee04dc020
commit e8fe0b0213
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/prepare-db-upgrade.md
View File

@@ -69,10 +69,10 @@ Although we have some automated testing of the scripts (e.g. to test that you ca
To test the upgrade script, run:
```
codeql test run --search-path=<old-extractor-pack> --search-path=ql <test-dir>
codeql test run --search-path=<old-extractor-pack> --search-path=<codeql-root> <test-dir>
```
Where `<old-extractor-pack>` is an extractor pack containing the old extractor and dbscheme that pre-date your changes, and `<test-dir>` is the directory containing the qltests for your language. This will run the tests using an old extractor, and the test databases will all be upgraded in place using your new upgrade script.
Where `<old-extractor-pack>` is an extractor pack containing the old extractor and dbscheme that pre-date your changes, `<test-dir>` is the directory containing the qltests for your language, and `<codeql-root>` is the root directory directory of the `github/codeql` clone that contains `<test-dir>`. This will run the tests using an old extractor, and the test databases will all be upgraded in place using your new upgrade script.
To test the downgrade script, create an extractor pack that includes your new dbscheme and extractor changes. Then checkout the `main` branch of `codeql` (i.e. a branch that does not include your changes), and run: