Skip to content

Commit 633a79c

Browse files
authored
Expand README for src/codeql-cli (#58902)
1 parent fc26275 commit 633a79c

1 file changed

Lines changed: 76 additions & 0 deletions

File tree

src/codeql-cli/README.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,79 @@ Slack: `#docs-engineering`
4646
Repo: `github/docs-engineering`
4747

4848
If you have a question about the CodeQL CLI pipeline, you can ask in the `#docs-engineering` Slack channel. If you notice a problem with the CodeQL CLI pipeline, you can open an issue in the `github/docs-engineering` repository.
49+
50+
## Dependency Matrix
51+
52+
### Required dependencies
53+
54+
| Dependency | Purpose | Installation | Notes |
55+
|------------|---------|--------------|-------|
56+
| **Pandoc** | Convert ReStructuredText to Markdown | `brew install pandoc` (macOS) | Version 2.x+ required |
57+
| **semmle-code repo** | Source ReStructuredText files | Clone at root of docs-internal | Private GitHub repo |
58+
| **Node.js** | Run sync script | Already in project | Version specified in `.nvmrc` |
59+
60+
### Source data location
61+
- **Repository**: `github/semmle-code` (private)
62+
- **Branch**: Configurable (default: `main`)
63+
- **Source files**: ReStructuredText documentation in semmle-code
64+
- **Output location**: `content/code-security/codeql-cli/codeql-cli-manual/`
65+
66+
### Version compatibility
67+
- CodeQL CLI releases approximately every 2 weeks
68+
- Pipeline should be run to align with CLI releases
69+
- Multiple CLI versions may be documented simultaneously
70+
71+
## Escalation Policy
72+
73+
### Ownership
74+
- **Team**: Docs Engineering
75+
- **Source team**: Code Security (CodeQL team)
76+
77+
### Escalation path
78+
1. **Pipeline failures** → #docs-engineering Slack
79+
2. **Source data issues** → #code-security-docs Slack
80+
3. **Pandoc conversion issues** → Check Pandoc version and file format
81+
4. **Repo access issues** → Request access to `github/semmle-code`
82+
83+
### On-call procedures
84+
If the pipeline fails:
85+
1. Check workflow logs for errors
86+
2. Verify Pandoc is installed and working
87+
3. Confirm access to `semmle-code` repo
88+
4. Check for ReStructuredText format changes
89+
5. Test conversion locally before re-running
90+
6. Escalate to Code Security team if source data issue
91+
92+
### Common failure modes
93+
- **Pandoc not found** - Install Pandoc locally or in CI
94+
- **semmle-code not cloned** - Clone repo at docs-internal root
95+
- **Conversion errors** - Check for unsupported RST syntax
96+
- **Branch not found** - Verify branch name in workflow input
97+
98+
## Known Constraints
99+
100+
### Pipeline limitations
101+
- **Manual trigger only** - No automated schedule (runs on-demand)
102+
- **Pandoc dependency** - Requires external tool installation
103+
- **Repo access** - Requires access to private `semmle-code` repo
104+
- **Local testing** - Must clone semmle-code locally to test
105+
106+
### Content constraints
107+
- **Frontmatter preservation** - Only first sync sets frontmatter
108+
- **Introduction placement** - Must be above auto-generation comment
109+
- **No inline editing** - Cannot edit autogenerated sections
110+
- **Version handling** - Limited liquid versioning support
111+
112+
### Technical constraints
113+
- **ReStructuredText format** - Source must be valid RST
114+
- **Pandoc conversion** - Limited control over conversion output
115+
- **File naming** - Determined by source file structure
116+
- **Link rewriting** - May need manual adjustment after generation
117+
118+
### Process constraints
119+
- **Release alignment** - Sync timing depends on CodeQL releases
120+
- **PR review required** - Changes must be reviewed before merge
121+
- **Content coordination** - Writers must coordinate intro additions
122+
- **Multiple versions** - May need separate syncs for version branches
123+
124+
We are not expecting significant new work to this pipeline, but we will support incoming changes from semmle-code.

0 commit comments

Comments
 (0)