Repository navigation
Add the usage and plugin authoring guides - #67
Merged
Merged
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Third and last deliverable of the product track: the usage documentation.
test: define what the usage documentation covers): the guides must name every command-line option, every rule the shipped plugins can report, the three report formats and the exit codes, every plugin base class and model kind of the plugin API, every bundled plugin, and every command they show must use options that exist.docs/usage.md: install, quick start, the option table, what is analysed and how taint travels, the rules grouped by family with their triggers and how flows are judged, the text, JSON and SARIF reports, advisories (OSV import, local file format), policy and SBOM, cache and jobs, the bundled plugins, a GitHub Actions example uploading SARIF, use from Python, the supported syntax and the intermediate representation.docs/plugins.md: plugin layout and loading, the manifest fields, canonical symbols, one example per kind of plugin (SymbolCallDetector,TaintDetector,ModelPluginwith the table of the ten model kinds and advisories,SecretDetector,ProjectPlugin, rawPluginwith the analyses it can read), findings, and how to test a plugin with the engine.