chore: update readme #157
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: Verify | |
| on: | |
| push: # TODO(@tmm): Remove once v2 is released | |
| workflow_call: | |
| workflow_dispatch: | |
| jobs: | |
| lint: | |
| name: Lint | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| steps: | |
| - name: Clone repository | |
| uses: actions/checkout@v3 | |
| - name: Install dependencies | |
| uses: ./.github/actions/install-dependencies | |
| - name: Lint code | |
| run: pnpm format && pnpm lint:fix | |
| - uses: stefanzweifel/git-auto-commit-action@v4 | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| with: | |
| commit_message: 'chore: format' | |
| commit_user_name: 'github-actions[bot]' | |
| commit_user_email: 'github-actions[bot]@users.noreply.github.com' | |
| build: | |
| name: Build | |
| needs: lint | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| steps: | |
| - name: Clone repository | |
| uses: actions/checkout@v3 | |
| - name: Install dependencies | |
| uses: ./.github/actions/install-dependencies | |
| - name: Build | |
| run: pnpm build | |
| - name: Publint | |
| run: pnpm test:build | |
| - name: Check for unused files, dependencies, and exports | |
| run: pnpm knip --production | |
| types: | |
| name: Types | |
| needs: lint | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| strategy: | |
| matrix: | |
| typescript-version: ['5.0.4', '5.1.6', 'latest'] | |
| # TODO: Run against multiple viem versions | |
| # viem-version: ['1.2.0', 'latest'] | |
| steps: | |
| - name: Clone repository | |
| uses: actions/checkout@v3 | |
| - name: Install dependencies | |
| uses: ./.github/actions/install-dependencies | |
| - run: pnpm add -D -w typescript@${{ matrix.typescript-version }} # viem@${{ matrix.viem-version }} | |
| - name: Link packages | |
| run: pnpm preconstruct | |
| - name: Check types | |
| run: pnpm typecheck | |
| # Redundant with `pnpm typecheck` | |
| # If Vitest adds special features in the future, e.g. type coverage, can add this back! | |
| # - name: Test types | |
| # run: pnpm test:typecheck | |
| test: | |
| name: Test | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| shard: [1, 2, 3] | |
| total-shards: [3] | |
| # TODO: Run against multiple viem versions | |
| # viem-version: ['1.2.0', 'latest'] | |
| steps: | |
| - name: Clone repository | |
| uses: actions/checkout@v3 | |
| - name: Install dependencies | |
| uses: ./.github/actions/install-dependencies | |
| # TODO: Run against multiple viem versions | |
| # - run: pnpm add -D -w viem@${{ matrix.viem-version }} | |
| # - run: pnpm test:update:viem | |
| - name: Run tests | |
| uses: nick-fields/retry@v2 | |
| with: | |
| command: CI=true pnpm test:cov --shard=${{ matrix.shard }}/${{ matrix.total-shards }} | |
| max_attempts: 3 | |
| timeout_minutes: 20 | |
| env: | |
| VITE_MAINNET_FORK_BLOCK_NUMBER: ${{ vars.VITE_MAINNET_FORK_BLOCK_NUMBER }} | |
| VITE_MAINNET_FORK_URL: ${{ secrets.VITE_MAINNET_FORK_URL }} | |
| VITE_OPTIMISM_FORK_BLOCK_NUMBER: ${{ vars.VITE_OPTIMISM_FORK_BLOCK_NUMBER }} | |
| VITE_OPTIMISM_FORK_URL: ${{ secrets.VITE_OPTIMISM_FORK_URL }} | |
| - name: Upload coverage reports to Codecov | |
| uses: codecov/codecov-action@v3 |