Skip to content

Commit f2ccb79

Browse files
authored
Merge pull request #4179 from d10c/d10c/update-docs
Update release/testing documentation
2 parents a2b1718 + a1283e9 commit f2ccb79

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

docs/releasing.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@
5252
or look at the source if there's any doubt the right code is being shipped.
5353
1. Install the `.vsix` file into your vscode IDE and ensure the extension can load properly. Run a single command (like run query, or add database).
5454
1. Approve the deployments of the [Release](https://github.com/github/vscode-codeql/actions?query=workflow%3ARelease) workflow run. This will automatically publish to Open VSX and VS Code Marketplace.
55+
- Note that in order to approve publishing to the extension marketplaces, you need to be part of *codeql-vscode-reviewers*.
5556
- If there is an authentication failure when publishing, be sure to check that the authentication keys haven't expired. See below.
5657
1. Go to the draft GitHub release in [the releases page](https://github.com/github/vscode-codeql/releases), click 'Edit', add some summary description, and publish it.
5758
1. Confirm the new release is marked as the latest release.

docs/test-plan.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@ choose to go through some of the Optional Test Cases.
8787
}
8888
```
8989

90+
More concretely, in the Variant Analysis Repositories pane of the CodeQL extension, click the "Open database configuration" (`{}`) button, and insert the JSON snippet above into the `.databases.variantAnalysis.repositoryLists[]` array. Alternatively, use the folder icon to create a new list, and add the abovementioned repos into the list using the "Add new database" (`+`) button.
91+
9092
3. Check that a notification message pops up and the results view is opened.
9193
4. Check the query history. It should:
9294
- Show that an item has been added to the query history
@@ -148,8 +150,9 @@ Run one of the above MRVAs, but cancel it from within VS Code:
148150
#### Test Case 6: Using model packs in MRVA
149151

150152
1. Create a model pack with mock data
151-
1. Create a new directory `test-model-pack`
152-
2. Create a `qlpack.yml` file in that directory with the following contents:
153+
1. Make sure you have `"codeQL.runningQueries.useExtensionPacks": "all"` enabled in the VSCode settings.
154+
1. Create a new directory `test-model-pack` anywhere in the workspace.
155+
1. Create a `qlpack.yml` file in that directory with the following contents:
153156

154157
```yaml
155158
name: github/test-model-pack
@@ -161,7 +164,7 @@ Run one of the above MRVAs, but cancel it from within VS Code:
161164
- extension.yml
162165
```
163166
164-
3. Create an `extension.yml` in the same directory with the following contents:
167+
1. Create an `extension.yml` in the same directory with the following contents:
165168

166169
```yaml
167170
extensions:
@@ -172,7 +175,7 @@ Run one of the above MRVAs, but cancel it from within VS Code:
172175
- ["vscode-codeql","Member[initialize].Argument[0]","code-injection"]
173176
```
174177

175-
2. In a Python query pack, create the following query (e.g. `sinks.ql`):
178+
1. In a Python query pack, create the following query (e.g. `sinks.ql`):
176179

177180
```ql
178181
import python
@@ -183,8 +186,8 @@ Run one of the above MRVAs, but cancel it from within VS Code:
183186
select path, kind
184187
```
185188

186-
3. Run a MRVA against a Python repository (e.g. `psf/requests`) with this query.
187-
4. Check that the results view contains 1 result with the values corresponding to the `extension.yml` file:
189+
1. Run a MRVA against a Python repository (e.g. `psf/requests`) with this query.
190+
1. Check that the results view contains 1 result with the values corresponding to the `extension.yml` file:
188191
![Model packs results table for `psf/requests`](images/model-pack-results-table.png)
189192

190193
### CodeQL Model Editor

0 commit comments

Comments
 (0)