chore: add comments to belief methods #3
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" | |
| env: | |
| DOTENV_CONFIG_PATH: "./.env.example" | |
| FOUNDRY_PROFILE: "ci" | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| push: | |
| jobs: | |
| ### Run Linters ### | |
| lint: | |
| name: "Run Linters" | |
| runs-on: "ubuntu-latest" | |
| steps: | |
| - name: "Check out the repo" | |
| uses: "actions/checkout@v3" | |
| with: | |
| submodules: "recursive" | |
| - name: "Install Foundry and restore the RPC cache, if any" | |
| uses: "foundry-rs/foundry-toolchain@v1" | |
| - name: "Install Node.js" | |
| uses: "actions/setup-node@v3" | |
| with: | |
| cache: "yarn" | |
| node-version: "lts/*" | |
| - name: "Install the Node.js dependencies" | |
| run: "yarn install --immutable --inline-builds" | |
| - name: "Lint the contracts" | |
| run: "yarn lint:sol" | |
| - name: "Add lint summary" | |
| run: | | |
| echo "## Lint results" >> $GITHUB_STEP_SUMMARY | |
| echo "✅ Passed" >> $GITHUB_STEP_SUMMARY | |
| ### Build Contracts ### | |
| build: | |
| name: "Build Contracts" | |
| runs-on: "ubuntu-latest" | |
| steps: | |
| - name: "Check out the repo" | |
| uses: "actions/checkout@v3" | |
| with: | |
| submodules: "recursive" | |
| - name: "Install Foundry and restore the RPC cache, if any" | |
| uses: "foundry-rs/foundry-toolchain@v1" | |
| - name: "Install Node.js" | |
| uses: "actions/setup-node@v3" | |
| with: | |
| cache: "yarn" | |
| node-version: "lts/*" | |
| - name: "Install the Node.js dependencies" | |
| run: "yarn install --immutable --inline-builds" | |
| - name: "Hardhat: Compile the contracts" | |
| run: | | |
| yarn clean | |
| yarn compile | |
| - name: "Forge: Build the contracts and print their size" | |
| run: | | |
| forge --version | |
| forge build --sizes | |
| - name: "Add build summary" | |
| run: | | |
| echo "## Build result" >> $GITHUB_STEP_SUMMARY | |
| echo "✅ Passed" >> $GITHUB_STEP_SUMMARY | |
| ### Run Hardhat Tests ### | |
| hardhat-test: | |
| name: "Run Hardhat Tests" | |
| needs: ["lint", "build"] | |
| runs-on: "ubuntu-latest" | |
| steps: | |
| - name: "Check out the repo" | |
| uses: "actions/checkout@v3" | |
| with: | |
| submodules: "recursive" | |
| - name: "Install Foundry and restore the RPC cache, if any" | |
| uses: "foundry-rs/foundry-toolchain@v1" | |
| - name: "Install Node.js" | |
| uses: "actions/setup-node@v3" | |
| with: | |
| cache: "yarn" | |
| node-version: "lts/*" | |
| - name: "Install the Node.js dependencies" | |
| run: "yarn install --immutable --inline-builds" | |
| - name: "Run Hardhat tests" | |
| run: "yarn test" | |
| - name: "Add Hardhat test summary" | |
| run: | | |
| echo "## Hardhat Tests result" >> $GITHUB_STEP_SUMMARY | |
| echo "✅ Passed" >> $GITHUB_STEP_SUMMARY | |
| ### Run Forge Tests ### | |
| forge-test: | |
| name: "Run Forge Tests" | |
| needs: ["lint", "build"] | |
| runs-on: "ubuntu-latest" | |
| steps: | |
| - name: "Check out the repo" | |
| uses: "actions/checkout@v3" | |
| with: | |
| submodules: "recursive" | |
| - name: "Install Foundry and restore the RPC cache, if any" | |
| uses: "foundry-rs/foundry-toolchain@v1" | |
| - name: "Install Node.js" | |
| uses: "actions/setup-node@v3" | |
| with: | |
| cache: "yarn" | |
| node-version: "lts/*" | |
| - name: "Install the Node.js dependencies" | |
| run: "yarn install --immutable --inline-builds" | |
| - name: "Show the Foundry config" | |
| run: "forge config" | |
| - name: "Generate fuzz seed that changes weekly to avoid burning through RPC allowance" | |
| run: > | |
| echo "FOUNDRY_FUZZ_SEED=$( | |
| echo $(($EPOCHSECONDS - $EPOCHSECONDS % 604800)) | |
| )" >> $GITHUB_ENV | |
| - name: "Run forge tests" | |
| run: "forge test" | |
| - name: "Add Forge test summary" | |
| run: | | |
| echo "## Forge Tests result" >> $GITHUB_STEP_SUMMARY | |
| echo "✅ Passed" >> $GITHUB_STEP_SUMMARY |