forked from decentralized-identity/web5-js
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implemented auto-publishing of documentation for Issue decentralized-…
- Loading branch information
Stack
authored and
Stack
committed
Dec 8, 2023
1 parent
61ac601
commit 4ee21e3
Showing
1 changed file
with
20 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,31 +2,44 @@ name: Publish Documentation | |
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
tags: | ||
- '*' | ||
workflow_dispatch: | ||
|
||
permissions: | ||
contents: read | ||
security-events: write | ||
|
||
jobs: | ||
build-and-deploy: | ||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: write | ||
security-events: write | ||
|
||
steps: | ||
- name: Checkout Repository | ||
uses: actions/checkout@v2 | ||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 #v4.1.1 | ||
|
||
- name: Set up Node.js | ||
uses: actions/setup-node@v2 | ||
uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0 | ||
with: | ||
node-version: '14' | ||
node-version: '18' | ||
|
||
- name: Install Dependencies | ||
run: npm install | ||
- name: Install dependencies for documentation | ||
run: | | ||
npm ci | ||
npm install [email protected] | ||
npm install jsdoc | ||
npm install clean-jsdoc-theme | ||
|
||
- name: Generate Documentation | ||
run: npx typedoc | ||
|
||
- name: Deploy to GitHub Pages | ||
uses: JamesIves/[email protected] | ||
with: | ||
branch: gh-pages # The branch the action should deploy to. | ||
folder: docs # The folder the action should deploy. | ||
branch: gh-pages | ||
folder: docs |