Skip to content

Commit d820971

Browse files
committed
Moved developer information into its own doc
1 parent 64ae420 commit d820971

File tree

2 files changed

+47
-46
lines changed

2 files changed

+47
-46
lines changed

README.md

Lines changed: 0 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -48,49 +48,3 @@ The code in this repository is licensed under the [MIT license](LICENSE).
4848

4949
- [Writing CodeQL queries](https://codeql.github.com/docs/writing-codeql-queries/)
5050
- [CodeQL documentation](https://codeql.github.com/docs/)
51-
52-
# Developer information
53-
54-
## Building the tools from source
55-
56-
[Install Rust](https://www.rust-lang.org/tools/install), then run:
57-
58-
```bash
59-
cargo build --release
60-
```
61-
62-
## Generating the database schema and QL library
63-
64-
The generated `ql/lib/ruby.dbscheme` and `ql/lib/codeql/ruby/ast/internal/TreeSitter.qll` files are included in the repository, but they can be re-generated as follows:
65-
66-
```bash
67-
# Run the generator
68-
cargo run --release -p ruby-generator -- --dbscheme ql/lib/ruby.dbscheme --library ql/lib/codeql/ruby/ast/internal/TreeSitter.qll
69-
# Then auto-format the QL library
70-
codeql query format -i ql/lib/codeql/ruby/ast/internal/TreeSitter.qll
71-
```
72-
73-
## Building a CodeQL database for a Ruby program
74-
75-
First, get an extractor pack. There are two options:
76-
77-
1. Either download the latest `codeql-ruby-pack` from Actions and unzip it twice, or
78-
2. Run `scripts/create-extractor-pack.sh` (Linux/Mac) or `scripts\create-extractor-pack.ps1` (Windows PowerShell) and the pack will be created in the `extractor-pack` directory.
79-
80-
Then run
81-
82-
```bash
83-
codeql database create <database-path> -l ruby -s <project-source-path> --search-path <extractor-pack-path>
84-
```
85-
86-
## Running qltests
87-
88-
Run
89-
90-
```bash
91-
codeql test run <test-path> --search-path <repository-root-path>
92-
```
93-
94-
## Writing database upgrade scripts
95-
96-
See [this guide](doc/prepare-db-upgrade.md).

doc/HOWTO.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Developer information
2+
3+
This document contains information about common development tasks.
4+
5+
## Building the tools from source
6+
7+
[Install Rust](https://www.rust-lang.org/tools/install), then run:
8+
9+
```bash
10+
cargo build --release
11+
```
12+
13+
## Generating the database schema and QL library
14+
15+
The generated `ql/lib/ruby.dbscheme` and `ql/lib/codeql/ruby/ast/internal/TreeSitter.qll` files are included in the repository, but they can be re-generated as follows:
16+
17+
```bash
18+
# Run the generator
19+
cargo run --release -p ruby-generator -- --dbscheme ql/lib/ruby.dbscheme --library ql/lib/codeql/ruby/ast/internal/TreeSitter.qll
20+
# Then auto-format the QL library
21+
codeql query format -i ql/lib/codeql/ruby/ast/internal/TreeSitter.qll
22+
```
23+
24+
## Building a CodeQL database for a Ruby program
25+
26+
First, get an extractor pack. There are two options:
27+
28+
1. Either download the latest `codeql-ruby-pack` from Actions and unzip it twice, or
29+
2. Run `scripts/create-extractor-pack.sh` (Linux/Mac) or `scripts\create-extractor-pack.ps1` (Windows PowerShell) and the pack will be created in the `extractor-pack` directory.
30+
31+
Then run
32+
33+
```bash
34+
codeql database create <database-path> -l ruby -s <project-source-path> --search-path <extractor-pack-path>
35+
```
36+
37+
## Running qltests
38+
39+
Run
40+
41+
```bash
42+
codeql test run <test-path> --search-path <repository-root-path>
43+
```
44+
45+
## Writing database upgrade scripts
46+
47+
See [this guide](prepare-db-upgrade.md).

0 commit comments

Comments
 (0)