This repository has been archived by the owner on Jan 5, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 125
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b8a54aa
commit 17cb1c9
Showing
1 changed file
with
7 additions
and
46 deletions.
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,54 +1,15 @@ | ||
| # Go analysis support for CodeQL | ||
| # Relocation notice: `github/codeql-go` moved into `github/codeql` | ||
|
|
||
| This open-source repository contains the extractor, CodeQL libraries, and queries that power Go | ||
| support in [LGTM](https://lgtm.com) and the other CodeQL products that [GitHub](https://github.com) | ||
| makes available to its customers worldwide. | ||
| - Old location: The `github/codeql-go` repository | ||
| - New location: The `github/codeql` repository, specifically https://github.com/github/codeql/tree/main/go. | ||
| - Detailed announcement: https://github.com/github/codeql-go/issues/741 | ||
|
|
||
| It contains two major components: | ||
| - an extractor, itself written in Go, that parses Go source code and converts it into a database | ||
| that can be queried using CodeQL. | ||
| - static analysis libraries and queries written in [CodeQL](https://codeql.github.com/docs/) that can be | ||
| used to analyze such a database to find coding mistakes or security vulnerabilities. | ||
| This repository previously contained the open-source CodeQL queries, libraries, and extractor for analyzing codebases written in the Go programming language with GitHub's CodeQL code analysis tools. These contents have been moved to the `github/codeql` repository, to live alongside similar libraries for all other programming languages supported by CodeQL. | ||
|
|
||
| The goal of this project is to provide comprehensive static analysis support for Go in CodeQL. | ||
| CodeQL support of the Go programming language remains the same, except that the code and the development will continue in `github/codeql`. | ||
|
|
||
| For the queries and libraries that power CodeQL support for other languages, visit [the CodeQL | ||
| repository](https://github.com/github/codeql). | ||
|
|
||
| ## Installation | ||
|
|
||
| Clone this repository. | ||
|
|
||
| Run `scripts/install-deps.sh`. This will ensure that the necessary external CodeQL packs are | ||
| downloaded to your machine. You will need to re-run this script whenever you pull new commits from | ||
| the repo. | ||
|
|
||
| If you want to use the CodeQL extension for Visual Studio Code, import this repository into your VS | ||
| Code workspace. | ||
|
|
||
| ## Usage | ||
|
|
||
| To analyze a Go codebase, either use the [CodeQL command-line | ||
| interface](https://codeql.github.com/docs/codeql-cli/) to create a database yourself, or | ||
| download a pre-built database from [LGTM.com](https://lgtm.com/). You can then run any of the | ||
| queries contained in this repository either on the command line or using the VS Code extension. | ||
|
|
||
| Note that the [lgtm.com](https://github.com/github/codeql-go/tree/lgtm.com) branch of this | ||
| repository corresponds to the version of the queries that is currently deployed on LGTM.com. | ||
| The [main](https://github.com/github/codeql-go/tree/main) branch may contain changes that | ||
| have not been deployed yet, so you may need to upgrade databases downloaded from LGTM.com before | ||
| running queries on them. | ||
|
|
||
| ## Contributions | ||
|
|
||
| Contributions are welcome! Please see our [contribution guidelines](CONTRIBUTING.md) and our | ||
| [code of conduct](CODE_OF_CONDUCT.md) for details on how to participate in our community. | ||
| Please visit https://github.com/github/codeql-go/issues/741 for more details about this relocation and how to update your CodeQL and code scanning workflows. | ||
|
|
||
| ## Licensing | ||
|
|
||
| The code in this repository is licensed under the [MIT license](LICENSE). | ||
|
|
||
| ## Resources | ||
|
|
||
| - [Writing CodeQL queries](https://codeql.github.com/docs/writing-codeql-queries/codeql-queries/) | ||
| - [Learning CodeQL](https://codeql.github.com/docs/writing-codeql-queries/ql-tutorials/) |