Introduce command to set default Code Tour database #2027
Merged
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
elenatanasoiu
force-pushed
the
elena/select-db-in-codespace
branch
from
d38017a to
1fe410f
Compare
shati-patel
reviewed
Jan 31, 2023
Contributor
shati-patel
left a comment
shati-patel
left a comment
There was a problem hiding this comment.
Looks good, but then we paired on this, so I'm happy for another pair of eyes 😅 👀
Contributor
|
[As discussed offline too] |
aeisenberg
reviewed
Feb 1, 2023
aeisenberg
reviewed
Feb 1, 2023
We have a codespace template which houses our CodeQL tour: https://github.com/github/codespaces-codeql This contains a repo with a default databases already loaded for the user so that they can start writing queries more quickly. At the moment we're asking the user to manually right click on the database folder ('codeql-tutorial-database') and set it as the current database. We can take this one step further by defining a command that gets triggered when we arrive at the step for setting up the database. The command ("codeQL.setDefaultTourDatabase") will build the URI pointing to our preloaded database and set it as the current one. We initially considered whether we can re-use the setCurrentDatabase command and pass the URI of the database from the codespace itself, but the URI would be hardcoded as: ``` file://0-62/workspaces/codespaces-codeql/codeql-tutorial-database ``` as we can only pass the codeTour extension a command and string parameters. This would have been brittle as the filepath for a codespace might change in the future. Instead we can define a custom tour command ("setDefaultTourDatabase") to look at the current workspace folder and build the path to the database in the CodeQL extension. Co-authored-by: Shati Patel <shati-patel@github.com>
Co-authored-by: Andrew Eisenberg <aeisenberg@github.com>
elenatanasoiu
force-pushed
the
elena/select-db-in-codespace
branch
from
6eaad25 to
99d794c
Compare
shati-patel
approved these changes
Feb 2, 2023
Contributor
shati-patel
left a comment
shati-patel
left a comment
There was a problem hiding this comment.
All comments addressed, thanks!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Makes this possible: github/codespaces-codeql#4
We have a codespace template which houses our CodeQL tour: https://github.com/github/codespaces-codeql
This contains a repo with a default databases already loaded for the user so that they can start writing queries more quickly.
At the moment we're asking the user to manually right click on the database folder (
codeql-tutorial-database) and set it as the current database.We can take this one step further by defining a command that gets triggered when we arrive at the step for setting up the database.
The command (
codeQL.setDefaultTourDatabase) will build the URI pointing to our preloaded database and set it as the current one.We initially considered whether we can re-use the
setCurrentDatabasecommand and pass the URI of the database from the codespace itself, but the URI would be hardcoded as:as we can only pass the codeTour extension a command and string parameters.
This would have been brittle as the filepath for a codespace might change in the future.
Instead we can define a custom tour command (
setDefaultTourDatabase) to look at the current workspace folder and build the path to the database in the CodeQL extension.We've made the command publicly visible so that we can execute it from our code tour.
Checklist
ready-for-doc-reviewlabel there.