docs: clean up(fix typo) the docs. #6047
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: Seaport Test CI | |
| on: | |
| push: | |
| branches: [main, 1.*, 2.*] | |
| tags: ["*"] | |
| pull_request: | |
| types: [opened, reopened, synchronize] | |
| concurrency: | |
| group: ${{github.workflow}}-${{github.ref}} | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| name: Build Artifacts | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| node-version: [18.15.0] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Use Node.js | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| cache: "yarn" | |
| - run: yarn install | |
| - run: yarn build | |
| lint: | |
| name: Run Linters | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| node-version: [18.15.0] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Use Node.js | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| cache: "yarn" | |
| - run: yarn install | |
| - run: yarn lint:check | |
| test: | |
| name: Run Tests | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| node-version: [18.15.0] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Use Node.js | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| cache: "yarn" | |
| - run: yarn install | |
| - run: yarn build | |
| - run: yarn test | |
| reference-test: | |
| name: Run Reference Tests | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| node-version: [18.15.0] | |
| env: | |
| REFERENCE: true | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Use Node.js | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| cache: "yarn" | |
| - run: yarn install | |
| - run: yarn build | |
| - run: yarn build:ref | |
| - run: yarn test:ref | |
| forge: | |
| name: Run Forge Tests (via_ir = true; fuzz_runs = 5000) | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 30 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| submodules: recursive | |
| - name: Install Foundry | |
| uses: foundry-rs/foundry-toolchain@v1 | |
| with: | |
| version: nightly | |
| - name: Install forge dependencies | |
| run: forge install | |
| - name: Precompile reference using 0.8.24 and via-ir=false | |
| run: FOUNDRY_PROFILE=reference forge build | |
| - name: Precompile optimized using 0.8.24 and via-ir=true | |
| run: FOUNDRY_PROFILE=optimized forge build | |
| - name: Run tests | |
| run: FOUNDRY_PROFILE=test forge test -vvv | |
| forge-ref: | |
| name: Run Forge Reference Tests (via_ir = false; fuzz_runs = 5000) | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 30 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| submodules: recursive | |
| - name: Install Foundry | |
| uses: foundry-rs/foundry-toolchain@v1 | |
| with: | |
| version: nightly | |
| - name: Install forge dependencies | |
| run: forge install | |
| - name: Precompile reference using 0.8.24 and via-ir=false | |
| run: FOUNDRY_PROFILE=reference forge build | |
| - name: Precompile optimized using 0.8.24 and via-ir=true | |
| run: FOUNDRY_PROFILE=optimized forge build | |
| - name: Run reference tests | |
| run: FOUNDRY_PROFILE=reference MOAT_PROFILE=reference forge test -vvv | |
| forge-offerers: | |
| name: Run Contract Offerer Forge Tests (via_ir = false; fuzz_runs = 1000) | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| submodules: recursive | |
| - name: Install Foundry | |
| uses: foundry-rs/foundry-toolchain@v1 | |
| with: | |
| version: nightly | |
| - name: Install forge dependencies | |
| run: forge install | |
| - name: Precompile reference using 0.8.24 and via-ir=false | |
| run: FOUNDRY_PROFILE=reference forge build | |
| - name: Precompile optimized using 0.8.24 and via-ir=true | |
| run: FOUNDRY_PROFILE=optimized forge build | |
| - name: Run tests | |
| run: FOUNDRY_PROFILE=offerers forge test -vvv | |
| forge-coverage: | |
| name: Run Forge Coverage report on tests | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| submodules: recursive | |
| - name: Install Foundry | |
| uses: foundry-rs/foundry-toolchain@v1 | |
| with: | |
| version: nightly | |
| - name: Install forge dependencies | |
| run: forge install | |
| - name: Run coverage with lcov output | |
| run: SEAPORT_COVERAGE=true forge coverage --report lcov | |
| - uses: codecov/codecov-action@v3 | |
| with: | |
| files: ./lcov.info | |
| flags: foundry | |
| # TODO: work out how to run legacy coverage (also how to run against core) | |
| # coverage: | |
| # name: Run Coverage Tests | |
| # runs-on: ubuntu-latest | |
| # | |
| # strategy: | |
| # matrix: | |
| # node-version: [18.15.0] | |
| # | |
| # steps: | |
| # - uses: actions/checkout@v3 | |
| # - name: Use Node.js | |
| # uses: actions/setup-node@v3 | |
| # with: | |
| # node-version: ${{ matrix.node-version }} | |
| # cache: "yarn" | |
| # - run: yarn install | |
| # - run: yarn build | |
| # - run: yarn coverage | |
| # - uses: codecov/codecov-action@v3 | |
| # with: | |
| # files: ./coverage/lcov.info | |
| # flags: production | |
| reference-coverage: | |
| name: Run Reference Coverage Tests | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| node-version: [18.15.0] | |
| env: | |
| REFERENCE: true | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Use Node.js | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| cache: "yarn" | |
| - run: yarn install | |
| - run: yarn build | |
| - run: yarn build:ref | |
| - run: yarn coverage:ref | |
| - uses: codecov/codecov-action@v3 | |
| with: | |
| files: ./coverage/lcov.info | |
| flags: reference |