Skip to content

Remove mentions of lgtm.com from README #1558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jf205 merged 1 commit into from
Sep 30, 2022
+8 −7
Merged

Remove mentions of lgtm.com from README #1558

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions extensions/ql-vscode/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ For information about other configurations, see the separate [CodeQL help](https

### Quick start: Using CodeQL

1. [Import a database from LGTM](#importing-a-database-from-lgtm).
1. [Import a database from GitHub](#importing-a-database-from-github).
1. [Run a query](#running-a-query).

---
Expand Down Expand Up @@ -73,18 +73,19 @@ If you're using your own clone of the CodeQL standard libraries, you can do a `g

You can find all the commands contributed by the extension in the Command Palette (**Ctrl+Shift+P** or **Cmd+Shift+P**) by typing `CodeQL`, many of them are also accessible through the interface, and via keyboard shortcuts.

### Importing a database from LGTM
### Importing a database from GitHub

While you can use the [CodeQL CLI to create your own databases](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/), the simplest way to start is by downloading a database from LGTM.com.
While you can use the [CodeQL CLI to create your own databases](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/), the simplest way to start is by downloading a database from GitHub.com.

1. Open [LGTM.com](https://lgtm.com/#explore) in your browser.
1. Search for a project you're interested in, for example [Apache Kafka](https://lgtm.com/projects/g/apache/kafka).
1. Copy the link to that project, for example `https://lgtm.com/projects/g/apache/kafka`.
1. In VS Code, open the Command Palette and choose the **CodeQL: Download Database from LGTM** command.
1. Find a project that you're interested in on GitHub.com, for example [Apache Kafka](https://github.com/apache/kafka).
1. Copy the link to that project, for example `https://github.com/apache/kafka`.
1. In VS Code, open the Command Palette and choose the **CodeQL: Download Database from GitHub** command.
1. Paste the link you copied earlier.
1. Select the language for the database you want to download (only required if the project has databases for multiple languages).
1. Once the CodeQL database has been imported, it is displayed in the Databases view.

For more information, see [Choosing a database](https://codeql.github.com/docs/codeql-for-visual-studio-code/analyzing-your-projects/#choosing-a-database) on codeql.github.com.
Copy link
Copy Markdown
Contributor

@aeisenberg aeisenberg Sep 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think there should be some guidance if the repository doesn't have a database? Also, is there an easy way for users to determine which repos already has one?

Copy link
Copy Markdown
Contributor Author

@jf205 jf205 Sep 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think there should be some guidance if the repository doesn't have a database?

Yes, there probably should. I think that belongs in the real VS Code docs though. I'll open a separate issue in github/codeql for that

Also, is there an easy way for users to determine which repos already has one?

You can check per-repo using the REST API (described in https://codeql.github.com/docs/codeql-for-visual-studio-code/analyzing-your-projects/#obtaining-a-local-database) but you can't get an overview of which repos already have dbs. We might add a way to do that later.

Copy link
Copy Markdown
Contributor

@aeisenberg aeisenberg Sep 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice. In the future, we can make this better. Being able to search for repos with dbs would be great. I've already spent lots of time looking for a suitable db to download. If I could issue a search, and find repos with dbs that match certain features, it would be helpful.


### Running a query

The instructions below assume that you're using the CodeQL starter workspace, or that you've added the CodeQL libraries and queries repository to your workspace.
Expand Down