Skip to content

Commit

Permalink
Auto docs (#539)
Browse files Browse the repository at this point in the history
* let GH actions generate the docs

* (dependabot) update GH actions
  • Loading branch information
MatthijsBurgh committed Dec 4, 2023
1 parent 85fd9a7 commit a1ce283
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,7 @@ updates:
ignore:
- dependency-name: "*"
update-types: ["version-update:semver-patch"]
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
28 changes: 28 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -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 }}

0 comments on commit a1ce283

Please # to comment.