Update docs/test-plan.md: "GitHub database download, Test case 1" regression #4180
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR adds a clarifying note to the test plan documentation regarding a known issue with database downloads. The note informs testers that if only one database appears in the list after downloading both C# and JavaScript databases, this is a known regression that has not yet been prioritized for fixing.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 3. Select the "C#" and "JavaScript" databases. | ||
| - Check that there are separate notifications for both downloads. | ||
| - Check that both databases are added when the downloads are complete. | ||
| - Note: if only one of the databases appears in the list, this is a known regression for which a fix has not been prioritized at the time of writing. |
There was a problem hiding this comment.
The note describes a known regression but lacks a reference to track its status. Consider adding a link to the relevant issue tracker (e.g., GitHub issue number) so testers can find more details or track when it gets fixed.
Suggested change
| - Note: if only one of the databases appears in the list, this is a known regression for which a fix has not been prioritized at the time of writing. | |
| - Note: if only one of the databases appears in the list, this is a known regression ([see issue #1234](https://github.com/github/codeql-vscode/issues/1234)) for which a fix has not been prioritized at the time of writing. |
cklin
approved these changes
Oct 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This concerns a regression which I've reproduced in releases 1.17.5 and 1.17.6. Not sure how long it's been there or how common it is, but fixing it has not been prioritized, so I'm amending the docs with a caveat for future release testers.
Downloading more than one database for the current repo (via the pop-up notification) does download them to disk, but adds only one of the databases to the database list after the downloads are complete.
Also, deleting the database that does appear in the UI deletes all of the other databases downloaded alongside it.