github / github/codeql

Where do library customization data extension YAML files go, and how can we actually develop and use them?

Open
#21,174 3 comments 0 reactions 0 assignees View on GitHub
question
Dominant language
CodeQL
Stars
10.1k
Forks
2.1k
Avg merge
2d 15h
Merged PRs (30d)
141

Description

The documentation for library customisation / data extensions describes the structure of the YAML files, but I cannot see any documentation on where these files should be placed, or how they can be invoked (or debugged) using CodeQL CLI or the vscode extension.

Some of the documentation implies that these YAML files are intended to be built into query packs and are loaded that way, but I didn't see any examples on how this is actually done in practice, nor any that explained how to develop and test the extensions before packing them.

Could someone provide some insight into this, and potentially update the documentation to include an example of a practical development flow using this feature? I know this feature is in beta, so the docs aren't 100% there yet, but a practical example would go a long way towards getting folks hands-on with it. Thanks.

Contributor guide

Open the contributing guide

Research direction

Start with the existing library customization and data extension documentation, then trace the query pack guidance and the CodeQL CLI and VS Code workflows mentioned in the issue. Add a practical example covering file placement, development, testing, invocation, and debugging; done means a newcomer can follow the flow before and after packing the extension.

Written by the indexing model from the issue text.

Assessment

Tech stack
vscode, yaml
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.