jf-roku/.github/workflows/build-docs.yml
Charles Ewert 00a6858c22
Auto update api docs and upload api docs to gh-pages (#1418)
Co-authored-by: cewert <cewert@users.noreply.github.com>
2023-10-26 22:19:51 -04:00

30 lines
822 B
YAML

name: build-docs
on:
push:
branches:
- unstable
jobs:
docs:
runs-on: ubuntu-latest
permissions:
# Give the default GITHUB_TOKEN write permission to commit and push the changed files back to the repository.
contents: write
steps:
- uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4
with:
ref: ${{ github.head_ref }}
token: ${{ secrets.JF_BOT_TOKEN }}
- name: Install NPM dependencies
run: npm ci
- name: Build API docs
# TODO: fix jsdoc build errors then remove '|| true' from run command below
run: npm run docs || true
- name: Commit any changes back to the unstable branch
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: Update API docs