RobotWebTools / rclnodejs / 24645561755

86%

push

github

Add GitHub Actions workflow to deploy JSDoc to GitHub (#1490)

Automate the JSDoc deployment that was previously a manual `npm run docs:gh-pages` + push-to-`gh-pages` process. The workflow leverages the existing `github-pages` deployment environment.

**Trigger**
- Tag push matching `docs-*` (e.g. `docs-1.9.0`) — builds and deploys
- Manual `workflow_dispatch` with a `dry_run` toggle (defaults to `true`) — build-only by default, deploy when `dry_run` is unchecked

**Build job**
- Full checkout (`fetch-depth: 0`) with tags, plus explicit `origin/gh-pages` fetch — required by `regenerate-published-docs.js` to discover and preserve previously published versions
- Runs `npm run docs:gh-pages` to stage the full docs tree under `build/gh-pages-docs/`
- Uploads the output via `upload-pages-artifact`

**Deploy job**
- Skipped when `dry_run` is `true`
- Deploys to GitHub Pages via `deploy-pages@v5`

**Changes**

| File | What changed |
|------|-------------|
| `.github/workflows/deploy-docs.yml` | New workflow |

Fix: #1489

1567 of 1987 branches covered (78.86%)

Branch coverage included in aggregate %.

3183 of 3545 relevant lines covered (89.79%)

447.86 hits per line