Skip to content

Commit

Permalink
ci(docs): Add new file
Browse files Browse the repository at this point in the history
Added new workflow files for generating and deploying JSDoc docs into GitHub pages
  • Loading branch information
The Alpha committed Sep 25, 2023
1 parent 3a8b86f commit 3e04668
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Generate and Deploy documentation

on:
release:
types: [published]
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: "lts/*"
registry-url: https://registry.npmjs.org

- name: Install dependencies
run: npm ci

- name: Build
run: npm run build --if-present

- name: Generate site
run: npm run doc

- name: Setup Pages
uses: actions/configure-pages@v3

- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: "./docs"

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2

0 comments on commit 3e04668

Please sign in to comment.