From b04734f70b16a2701e9a67cabd6dd2fd367ceb19 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nora=20Dimitrijevi=C4=87?= Date: Mon, 27 Oct 2025 17:47:52 +0100 Subject: [PATCH 1/2] Update release/testing documentation Added clarifications based on my experience releasing the extension for the first time. --- docs/releasing.md | 1 + docs/test-plan.md | 15 +++++++++------ 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/releasing.md b/docs/releasing.md index 2d1495c5dc6..cb46ab61dfb 100644 --- a/docs/releasing.md +++ b/docs/releasing.md @@ -52,6 +52,7 @@ or look at the source if there's any doubt the right code is being shipped. 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). 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. + - Note that in order to approve publishing to the extension marketplaces, you need to be part of *codeql-vscode-reviewers*. - If there is an authentication failure when publishing, be sure to check that the authentication keys haven't expired. See below. 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. 1. Confirm the new release is marked as the latest release. diff --git a/docs/test-plan.md b/docs/test-plan.md index 90fe3cc2abf..2ae3a45c4ef 100644 --- a/docs/test-plan.md +++ b/docs/test-plan.md @@ -87,6 +87,8 @@ choose to go through some of the Optional Test Cases. } ``` + 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. + 3. Check that a notification message pops up and the results view is opened. 4. Check the query history. It should: - 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: #### Test Case 6: Using model packs in MRVA 1. Create a model pack with mock data - 1. Create a new directory `test-model-pack` - 2. Create a `qlpack.yml` file in that directory with the following contents: + 1. Make sure you have `"codeQL.runningQueries.useExtensionPacks": "all"` enabled in the VSCode settings. + 1. Create a new directory `test-model-pack` anywhere in the workspace. + 1. Create a `qlpack.yml` file in that directory with the following contents: ```yaml name: github/test-model-pack @@ -161,7 +164,7 @@ Run one of the above MRVAs, but cancel it from within VS Code: - extension.yml ``` - 3. Create an `extension.yml` in the same directory with the following contents: + 1. Create an `extension.yml` in the same directory with the following contents: ```yaml extensions: @@ -172,7 +175,7 @@ Run one of the above MRVAs, but cancel it from within VS Code: - ["vscode-codeql","Member[initialize].Argument[0]","code-injection"] ``` -2. In a Python query pack, create the following query (e.g. `sinks.ql`): +1. In a Python query pack, create the following query (e.g. `sinks.ql`): ```ql import python @@ -183,8 +186,8 @@ Run one of the above MRVAs, but cancel it from within VS Code: select path, kind ``` -3. Run a MRVA against a Python repository (e.g. `psf/requests`) with this query. -4. Check that the results view contains 1 result with the values corresponding to the `extension.yml` file: +1. Run a MRVA against a Python repository (e.g. `psf/requests`) with this query. +1. Check that the results view contains 1 result with the values corresponding to the `extension.yml` file: ![Model packs results table for `psf/requests`](images/model-pack-results-table.png) ### CodeQL Model Editor From a1283e9a6e69cc750264612bf04b83efd6b5f861 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nora=20Dimitrijevi=C4=87?= Date: Mon, 27 Oct 2025 17:58:18 +0100 Subject: [PATCH 2/2] Update docs/test-plan.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/test-plan.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/test-plan.md b/docs/test-plan.md index 2ae3a45c4ef..e847e7f61e6 100644 --- a/docs/test-plan.md +++ b/docs/test-plan.md @@ -87,7 +87,7 @@ choose to go through some of the Optional Test Cases. } ``` - 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. + 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. 3. Check that a notification message pops up and the results view is opened. 4. Check the query history. It should: