mention known issues in readme #44
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: Documentation | |
| on: | |
| pull_request: | |
| branches: [main] | |
| push: | |
| branches: [main] | |
| jobs: | |
| checks: | |
| if: github.event_name != 'push' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v1 | |
| - uses: actions/setup-node@v1 | |
| with: | |
| node-version: '16.x' | |
| - name: Test Build | |
| run: | | |
| cd docs | |
| if [ -e yarn.lock ]; then | |
| yarn install --frozen-lockfile | |
| elif [ -e package-lock.json ]; then | |
| npm ci | |
| else | |
| npm i | |
| fi | |
| npm run build | |
| gh-release: | |
| if: github.event_name != 'pull_request' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v1 | |
| - uses: actions/setup-node@v1 | |
| with: | |
| node-version: '16.x' | |
| - uses: webfactory/ssh-agent@v0.5.4 | |
| with: | |
| ssh-private-key: ${{ secrets.GH_PAGES_DEPLOY }} | |
| - name: Release to GitHub Pages | |
| env: | |
| USE_SSH: true | |
| GIT_USER: git | |
| run: | | |
| cd docs | |
| git config --global user.email "actions@github.com" | |
| git config --global user.name "gh-actions" | |
| if [ -e yarn.lock ]; then | |
| yarn install --frozen-lockfile | |
| elif [ -e package-lock.json ]; then | |
| npm ci | |
| else | |
| npm i | |
| fi | |
| npm run deploy |