Update CONTRIBUTING.md #138
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 check | |
| on: | |
| push: | |
| branches: [main] | |
| tags: | |
| - "*" | |
| pull_request: | |
| branches: [main] | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| name: runs typescript and tests | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Install Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: current | |
| - uses: pnpm/action-setup@v3 | |
| name: Install pnpm | |
| id: pnpm-install | |
| with: | |
| version: 8 | |
| run_install: false | |
| - name: Get pnpm store directory | |
| id: pnpm-cache | |
| run: | | |
| echo "::set-output name=pnpm_cache_dir::$(pnpm store path)" | |
| - uses: actions/cache@v4 | |
| name: Setup pnpm cache | |
| with: | |
| path: ${{ steps.pnpm-cache.outputs.pnpm_cache_dir }} | |
| key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pnpm-store- | |
| - name: Install dependencies | |
| run: pnpm install | |
| - name: run TS | |
| run: pnpm ts | |
| - name: run tests | |
| env: | |
| LANGTAIL_API_KEY: ${{secrets.LANGTAIL_API_KEY}} | |
| TEST_LIVE: true | |
| run: pnpm test | |
| publish: | |
| runs-on: ubuntu-latest | |
| name: Publish to NPM | |
| needs: build | |
| if: startsWith(github.ref, 'refs/tags/v') | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Install Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: current | |
| - uses: pnpm/action-setup@v3 | |
| name: Install pnpm | |
| id: pnpm-install | |
| with: | |
| version: 8 | |
| run_install: false | |
| - name: Get pnpm store directory | |
| id: pnpm-cache | |
| run: | | |
| echo "::set-output name=pnpm_cache_dir::$(pnpm store path)" | |
| - uses: actions/cache@v4 | |
| name: Setup pnpm cache | |
| with: | |
| path: ${{ steps.pnpm-cache.outputs.pnpm_cache_dir }} | |
| key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pnpm-store- | |
| - name: Install dependencies and build | |
| run: | | |
| pnpm install | |
| pnpm build | |
| - uses: JS-DevTools/npm-publish@v3 | |
| name: Publish package | |
| with: | |
| token: ${{ secrets.NPM_TOKEN }} |