Add build workflow job with concentrated docs artefact #1452
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: CI | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| push: | |
| branches: | |
| - master | |
| jobs: | |
| CI: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| node-version: [14.x, 16.x, 18.x, 20.x] | |
| steps: | |
| - name: Checkout | |
| uses: actions/[email protected] | |
| - name: Use Node.js ${{ matrix.node-version }} | |
| uses: actions/[email protected] | |
| with: | |
| cache: npm | |
| node-version: ${{ matrix.node-version }} | |
| - name: Check dependency duplications | |
| uses: vazco/open-standards/actions/npm-dependency-duplications/@master | |
| - name: Check dependency vulnerabilities | |
| uses: vazco/open-standards/actions/npm-dependency-vulnerabilities/@master | |
| - name: Install | |
| run: npm i -g npm@8 --no-audit && npm ci --no-audit | |
| - name: Lint | |
| run: npm run lint | |
| - name: Test | |
| run: npm run coverage -- --no-cache --runInBand | |
| - name: Report coverage | |
| uses: codecov/[email protected] | |
| with: | |
| fail_ci_if_error: true | |
| env: | |
| CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} | |
| Docs: | |
| runs-on: ubuntu-latest | |
| needs: CI | |
| if: success() && github.event_name == 'push' && github.ref == 'refs/heads/master' | |
| steps: | |
| - name: Checkout | |
| uses: actions/[email protected] | |
| - name: Use Node.js 20 | |
| uses: actions/[email protected] | |
| with: | |
| cache: npm | |
| node-version: 20 | |
| - name: Install | |
| run: npm ci --no-audit | |
| - name: Build docs | |
| run: npm --prefix website run build | |
| - name: Deploy docs | |
| uses: peaceiris/[email protected] | |
| with: | |
| allow_empty_commit: true | |
| cname: uniforms.tools | |
| force_orphan: true | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./website/build | |
| - name: Create a concentrated doc file | |
| run: node ./scripts/concatenateDocs.js . uniformsConcentratedDocs.md | |
| - name: Upload the concentrated doc file as an artifact | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: uniformsConcentratedDocs-${{ github.sha }}-${{ github.run_id }}-$(date +'%Y-%m-%d').md | |
| path: uniformsConcentratedDocs.md |