From a1ce28389748e1f229c3a70191ed4afa304b91fa Mon Sep 17 00:00:00 2001 From: Matthijs van der Burgh Date: Tue, 3 May 2022 10:57:01 +0200 Subject: [PATCH] Auto docs (#539) * let GH actions generate the docs * (dependabot) update GH actions --- .github/dependabot.yml | 4 ++++ .github/workflows/docs.yml | 28 ++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 71054bd3a..93c0ce478 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -7,3 +7,7 @@ updates: ignore: - dependency-name: "*" update-types: ["version-update:semver-patch"] + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 000000000..eeae26ae2 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,28 @@ +name: Docs Deployment + +on: + release: + types: [released] + +jobs: + docs: + name: Docs Deployment + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v3 + with: + node-version: 16 + - name: Install + run: npm ci + - name: Generate docs + run: npm run doc + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.RWT_BOT_PAT }} + publish_dir: doc + destination_dir: . + enable_jekyll: false + force_orphan: false # So we keep the doc history + commit_message: JSDoc ${{ github.event.release.name }}