README: Fixup build instructions #283
Workflow file for this run
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
| name: Docs | |
| on: | |
| push: | |
| branches: [ main ] | |
| pull_request: | |
| branches: [ main ] | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Cache node modules | |
| uses: actions/cache@v1 | |
| with: | |
| path: node_modules | |
| key: ${{ runner.OS }}-build-${{ hashFiles('**/package-lock.json') }} | |
| restore-keys: | | |
| ${{ runner.OS }}-build-${{ env.cache-name }}- | |
| ${{ runner.OS }}-build- | |
| ${{ runner.OS }}- | |
| - name: Install Dependencies | |
| run: npm ci | |
| - name: Build doc | |
| run: npm run doc | |
| - name: Archive www Artifact | |
| uses: actions/upload-artifact@master | |
| with: | |
| name: documentation | |
| path: documentation | |
| deploy: | |
| name : Deploy 🚀 | |
| needs: [build] | |
| if: github.ref == 'refs/heads/main' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Repo | |
| uses: actions/checkout@master | |
| - name: Download Artifact | |
| uses: actions/download-artifact@master | |
| with: | |
| name: documentation | |
| path: documentation | |
| - name: Deploy to github pages | |
| uses: JamesIves/github-pages-deploy-action@4.1.0 | |
| with: | |
| branch: gh-pages | |
| folder: documentation | |
| CLEAN: true |