Skip to content

Commit a9b63cb

Browse files
committed
Open extension on first step of code tour
Follow up to github/vscode-codeql#2188. We changed the extension to automatically open the code tour workspace file when you click on it. In the code tour, we open the extension on the sixth step. This is quite late in the process, we want to have everything ready for the user from step 1. We want to add an extra step at the start of the tour where we open the extension to force the workspace to be opened. This has an added advantage that it will also display the pop-up to ask for permission to record telemetry. So we get these issues out of the way on the first step. Side-note: if the user ignores the tour and goes off and clicks on the extension on their own, we'll load the workspace for them (🎉 🎉 🎉), so we're not tied to the tour to make the codespace behave as expected.
1 parent 39ead74 commit a9b63cb

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

.tours/codeql-tutorial.tour

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,29 @@
44
"isPrimary": true,
55
"steps": [
66
{
7-
"description": "First let's talk about the CodeQL CLI.\n\nThe CodeQL extension uses the CodeQL CLI to compile and run queries. It automatically manages access to the executable of the CLI for you.\n\nWe've already set it up to use in this tutorial. To learn more about the CodeQL CLI, see [the docs](https://codeql.github.com/).",
7+
"description": "Welcome to the CodeQL tour!\n\nIn the next steps, we'll start exploring the CodeQL extension. If this is your first time activating the extension, you may be prompted to reload your workspace and decide whether to allow telemetry.\n\nTo get started, click 'Next (The CodeQL extension)'.",
8+
"title": "Welcome!"
9+
},
10+
{
11+
"description": "The CodeQL extension adds rich language support for CodeQL and allows you to easily find problems in codebases.",
12+
"title": "The CodeQL extension",
13+
"view": "codeQLDatabases"
14+
},
15+
{
16+
"description": "The CodeQL extension uses the CodeQL CLI to compile and run queries. It automatically manages access to the executable of the CLI for you.\n\nWe've already set it up to use in this tutorial. To learn more about the CodeQL CLI, see [the docs](https://codeql.github.com/).",
817
"title": "The CodeQL CLI"
918
},
1019
{
1120
"directory": ".tours/codeql-tutorial-database",
12-
"description": "To run a CodeQL query, we first need to select [a CodeQL database](https://codeql.github.com/docs/codeql-overview/about-codeql/#about-codeql-databases).\n\nWe've just added a sample one and set it as your current database.\n\nClick 'Next' to see the database.",
21+
"description": "To run a CodeQL query, we first need to select [a CodeQL database](https://codeql.github.com/docs/codeql-overview/about-codeql/#about-codeql-databases).\n\nWe've just added a sample one (CodeQL Tutorial Database) and set it as your current database in the extension.",
1322
"commands": [
1423
"codeQL.setDefaultTourDatabase"
1524
],
1625
"title": "Your first database"
1726
},
1827
{
1928
"title": "The CodeQL extension",
20-
"description": "We've now moved into the CodeQL extension!\n\nOn the left hand side, you can see the 'DATABASES' panel where the 'CodeQL Tutorial Database' is present and is selected with a check mark.",
29+
"description": "On the left hand side, you can see the 'DATABASES' panel where the 'CodeQL Tutorial Database' is present and is selected with a check mark.",
2130
"view": "codeQLDatabases"
2231
},
2332
{
@@ -49,7 +58,7 @@
4958
},
5059
{
5160
"file": "tutorial-queries/tutorial.ql",
52-
"description": "It is time to run your first query!\n\nWe started the process in the background, the results will appear in a new 'CodeQL Query Results' tab shortly.",
61+
"description": "It's time to run your first query!\n\nWe started the process in the background, the results will appear in a new 'CodeQL Query Results' tab shortly.",
5362
"selection": {
5463
"start": {
5564
"line": 7,

0 commit comments

Comments
 (0)