You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+12-2Lines changed: 12 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -77,9 +77,9 @@ $ vscode/scripts/code-cli.sh --install-extension dist/vscode-codeql-*.vsix # if
77
77
78
78
You can use VS Code to debug the extension without explicitly installing it. Just open this directory as a workspace in VS Code, and hit `F5` to start a debugging session.
79
79
80
-
### Running the unit/integration tests
80
+
### Running the unit tests and integration tests that do not require a CLI instance
81
81
82
-
Ensure the `CODEQL_PATH` environment variable is set to point to the `codeql` cli executable.
82
+
Unit tests and many integration tests do not require a copy of the CodeQL CLI.
83
83
84
84
Outside of vscode, run:
85
85
@@ -89,6 +89,16 @@ npm run test && npm run integration
89
89
90
90
Alternatively, you can run the tests inside of vscode. There are several vscode launch configurations defined that run the unit and integration tests. They can all be found in the debug view.
91
91
92
+
Only the _With CLI_ tests require a CLI instance to run. See below on how to do that.
93
+
94
+
Running from a terminal, you _must_ set the `TEST_CODEQL_PATH` variable to point to a checkout of the `github/codeql` repository. The appropriate CLI version will be downloaded as part of the test.
95
+
96
+
### Running the integration tests
97
+
98
+
The _Launch Integration Tests - With CLI_ tests require a CLI instance in order to run. There are several environment variables you can use to configure this.
99
+
100
+
From inside of VSCode, open the `launch.json` file and in the _Launch Integration Tests - With CLI_ uncomment and change the environment variables appropriate for your purpose.
101
+
92
102
## Releasing (write access required)
93
103
94
104
1. Double-check the `CHANGELOG.md` contains all desired change comments and has the version to be released with date at the top.
0 commit comments