Skip to content

Commit a54e5a1

Browse files
themr0cclaude
andcommitted
docs: add README for build/scripts
Quick reference for each script, CQA usage, and workflow mappings. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 485abaa commit a54e5a1

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

build/scripts/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Build Scripts
2+
3+
Build, deploy, and content quality tooling for the RHDH documentation project.
4+
5+
## Scripts
6+
7+
| Script | Purpose |
8+
|---|---|
9+
| `build-ccutil.sh` | Wrapper that delegates to `build-orchestrator.js`. Used by `build-asciidoc.yml` and as a fallback in `pr.yml` on older branches. |
10+
| `build-orchestrator.js` | Parallel documentation build orchestrator. Runs ccutil title builds, lychee link validation, and CQA assessment. Produces `build-report.json`. |
11+
| `deploy-gh-pages.js` | Deploys build output to the `gh-pages` branch. Handles cleanup of stale PR/branch directories, index regeneration with release notes links, and retry with rebase on push conflicts. |
12+
| `error-patterns.json` | Regex patterns for classifying ccutil build errors into structured messages with cause and fix fields. |
13+
| `update-cqa-resources.sh` | Fetches upstream Red Hat style guide resources into `.claude/resources/`. |
14+
15+
## CQA (`cqa/`)
16+
17+
Content Quality Assessment framework with 19 checks (CQA-00a through CQA-17).
18+
19+
```bash
20+
node build/scripts/cqa/index.js titles/<title>/master.adoc # report
21+
node build/scripts/cqa/index.js --fix titles/<title>/master.adoc # auto-fix
22+
node build/scripts/cqa/index.js --check 14 titles/<title>/master.adoc # single check
23+
node build/scripts/cqa/index.js --all # all titles
24+
```
25+
26+
See `.claude/plugins/project-cqa/resources/cqa-spec.md` for the full specification.
27+
28+
## Workflows
29+
30+
These scripts are called by GitHub Actions workflows in `.github/workflows/`:
31+
32+
- **`build-asciidoc.yml`** (push to main/release) -- `build-ccutil.sh` + `deploy-gh-pages.js`
33+
- **`pr.yml`** (pull requests) -- `build-orchestrator.js` (or `build-ccutil.sh` on older branches) + `deploy-gh-pages.js`
34+
35+
See `docs/github-publication-workflow.md` for the full architecture documentation.

0 commit comments

Comments
 (0)