add jsdoc #178
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: | |
| push: | |
| pull_request: | |
| jobs: | |
| test: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| node-version: [18.x, 20.x] | |
| # See supported Node.js release schedule at https://nodejs.org/en/about/releases/ | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Use Node.js ${{ matrix.node-version }} | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| cache: 'npm' | |
| - run: npm ci | |
| - name: Check for linting errors (run `npm run lint:fix` to fix) | |
| run: npm run lint | |
| - name: Check for prettier errors (run `npm run format` to fix) | |
| run: npx prettier --check . | |
| - name: Run unit tests | |
| run: npm test | |
| - name: Build the npm package to publish | |
| run: npm pack | |
| - uses: actions/upload-artifact@v3 | |
| with: | |
| name: package | |
| path: '*.tgz' |