diff --git a/.github/skills/bazel/SKILL.md b/.github/skills/bazel/SKILL.md index 0352fc1c2b16..89fca3f8c260 100644 --- a/.github/skills/bazel/SKILL.md +++ b/.github/skills/bazel/SKILL.md @@ -5,9 +5,6 @@ description: Conventions for editing Bazel files in the github/codeql repository # Bazel in the codeql repository -A bzlmod module named `ql`, repo name `@codeql` ([`MODULE.bazel`](../../../MODULE.bazel)). It builds standalone, and is -also consumed by an internal module; standalone builds replace that module with a stub. - ## Traps Things that will waste your time or produce a wrong edit here. Read this section even if you skip the rest. @@ -26,7 +23,7 @@ Things that will waste your time or produce a wrong edit here. Read this section ## Conventions -* **Copy a neighboring target rather than inventing a shape.** Packaging is not uniform: some packages use the +* Packaging is not uniform: some packages use the `codeql_*` wrappers, others still use `pkg_files` directly. Copy the closest *working* neighbor, and prefer the wrapper for new code. * **Pin anything fetched over the network** with `sha256` or `integrity`. Bazel only *warns* on an unpinned download, so diff --git a/rust/ast-generator/README.md b/rust/ast-generator/README.md index 21193bdee1c5..d98806ace6d6 100644 --- a/rust/ast-generator/README.md +++ b/rust/ast-generator/README.md @@ -13,3 +13,5 @@ bazel run //rust/ast-generator:inject-sources which will create the missing sources. Be aware that bazel will still use the source taken directly from `rust-analyzer`, not the one in your working copy. Those should not need to be update often though. + +To retain changes to injected sources in Bazel builds, update `rust/ast-generator/patches/rust-analyzer.patch`. diff --git a/unified/AGENTS.md b/unified/AGENTS.md index 72de05d120be..5362d63a66ef 100644 --- a/unified/AGENTS.md +++ b/unified/AGENTS.md @@ -1,9 +1,5 @@ # Agent instructions -This is a CodeQL extractor that maps a language's parse tree onto a shared AST -using the `yeast` desugaring engine. Swift, the only language so far, is parsed -by Apple's swift-syntax rather than by tree-sitter. - ## Building - To build the extractor, run `scripts/create-extractor-pack.sh` @@ -42,6 +38,6 @@ by Apple's swift-syntax rather than by tree-sitter. - To run all CodeQL tests, run `codeql test run --search-path extractor-pack ql/test` -- Do not edit `.expected` files manually. To update the expected output, pass `--learn` to the `codeql test run` command. +- To update the expected output, pass `--learn` to the `codeql test run` command. - To run a specific test, pass the specific directory to the `codeql test run` command instead of `ql/test`.