Skip to content

Commit

Permalink
add docs workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
devsnek committed Sep 17, 2020
1 parent b4ecc6c commit 6a6718b
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 2 deletions.
20 changes: 20 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
on:
push:
branches:
- master

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: '14'
- run: "npm install"
- run: "npm run docs"
- uses: JamesIves/[email protected]
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages
FOLDER: docs-out
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
node_modules/**
package-lock.json
docs.json
browser.js
test/auth.js
docs-out
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
},
"scripts": {
"lint": "eslint src test --ext=js",
"docs": "docgen --source src --output docs.json --jsdoc jsdoc.json --custom docgen.json",
"docs": "mkdir -p docs-out && docgen --source src --output docs-out/master.json --jsdoc jsdoc.json --custom docgen.json",
"example": "electron example/main.js",
"build:browser": "webpack-cli",
"prepublishOnly": "npm run lint && npm run build:browser"
Expand Down

0 comments on commit 6a6718b

Please sign in to comment.