automated documentation deployment
Workflow file: .github/workflows/jsdoc-build.yaml. Trigger: push to main.
Job#
flowchart TD push[push main] --> co[actions/checkout@v2] co --> ver[Get package version] ver --> build[andstor/jsdoc-action@v1] build --> deploy[peaceiris/actions-gh-pages@v3]
Steps in source:
- Checkout
@v2 echo "version=$(node -p "require('./package.json').version")" >> $GITHUB_OUTPUTandstor/jsdoc-action@v1withrecurse: trueandconfig_file: jsdoc.conf.jsonpeaceiris/actions-gh-pages@v3withpublish_dir: ./docs/jsjiit/${{ steps.get_version.outputs.version }}andGITHUB_TOKEN
permissions.contents: write is set on the job. Runner: ubuntu-latest.
Version folder#
flowchart LR pkg["package.json version 0.0.22"] --> out[docs/jsjiit/0.0.22] out --> pages[gh-pages branch]
JSDoc’s own config writes ./docs. The publish directory expects ./docs/jsjiit/{version}. If pages come out empty, the destination mismatch is the first thing to check. The workflow does not rewrite jsdoc.conf.json before the Action.
What this site is not#
flowchart TB gha[GitHub Pages JSDoc HTML] here[tashif.codes markdown under src/data/docs/jsjiit]
This markdown set is hand-written against the 0.0.22 clone. It does not deploy from jsdoc-build.yaml.