docs(readme): add examples #62
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: build | |
| on: [push, pull_request] | |
| permissions: | |
| contents: write | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Use Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| cache: npm | |
| node-version-file: .nvmrc | |
| - name: Install dependencies | |
| run: npm ci --prefer-offline | |
| - name: Run ESLint | |
| run: npm run lint | |
| - name: Check type | |
| run: npm run lint:tsc | |
| - name: Run unit tests | |
| run: npm run test:ci | |
| - name: Codecov | |
| uses: codecov/codecov-action@v3 | |
| - name: Run module tests | |
| run: npm run test:esm | |
| - name: Build package | |
| run: npm run build | |
| - name: Generate docs | |
| run: npm run docs | |
| - name: Deploy | |
| if: github.ref == 'refs/heads/master' | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| branch: gh-pages | |
| folder: docs |