Merge pull request #85 from flood-protocol/tests-and-documentation #300
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: | |
| branches: | |
| - master | |
| pull_request: | |
| env: | |
| FOUNDRY_PROFILE: ci | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - name: Install Foundry | |
| uses: foundry-rs/foundry-toolchain@v1 | |
| with: | |
| version: nightly | |
| - name: Install deps | |
| run: forge install | |
| - name: Build contracts | |
| run: | | |
| forge --version | |
| forge build --sizes | |
| test: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - name: Install Foundry | |
| uses: foundry-rs/foundry-toolchain@v1 | |
| with: | |
| version: nightly | |
| - name: Install deps | |
| run: forge install | |
| - name: Run tests | |
| run: forge test | |
| coverage: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - name: Install Foundry | |
| uses: foundry-rs/foundry-toolchain@v1 | |
| - name: Install deps | |
| run: forge install | |
| - name: Run coverage | |
| run: forge coverage --report summary --report lcov | |
| # To ignore coverage for certain directories modify the paths in this step as needed. The | |
| # below default ignores coverage results for the test and script directories. Alternatively, | |
| # to include coverage in all directories, comment out this step. Note that because this | |
| # filtering applies to the lcov file, the summary table generated in the previous step will | |
| # still include all files and directories. | |
| # The `--rc lcov_branch_coverage=1` part keeps branch info in the filtered report, since lcov | |
| # defaults to removing branch info. | |
| - name: Filter directories | |
| run: | | |
| sudo apt update && sudo apt install -y lcov | |
| lcov --remove lcov.info 'test/*' 'script/*' --output-file lcov.info --rc lcov_branch_coverage=1 | |
| # This step posts a detailed coverage report as a comment and deletes previous comments on | |
| # each push. The below step is used to fail coverage if the specified coverage threshold is | |
| # not met. The below step can post a comment (when it's `github-token` is specified) but it's | |
| # not as useful, and this action cannot fail CI based on a minimum coverage threshold, which | |
| # is why we use both in this way. | |
| - name: Post coverage report | |
| if: github.event_name == 'pull_request' # This action fails when ran outside of a pull request. | |
| uses: romeovs/[email protected] | |
| with: | |
| delete-old-comments: true | |
| lcov-file: ./lcov.info | |
| github-token: ${{ secrets.GITHUB_TOKEN }} # Adds a coverage summary comment to the PR. | |
| - name: Verify minimum coverage | |
| uses: zgosalvez/github-actions-report-lcov@v2 | |
| with: | |
| coverage-files: ./lcov.info | |
| minimum-coverage: 90 # Set coverage threshold. | |
| slither-analyze: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| security-events: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - name: Run Slither | |
| uses: crytic/[email protected] | |
| id: slither # Required to reference this step in the next step. | |
| with: | |
| fail-on: none # Required to avoid failing the CI run regardless of findings. | |
| sarif: results.sarif | |
| slither-args: --filter-paths "./lib|./test|./node_modules" --exclude naming-convention | |
| - name: Upload SARIF file | |
| uses: github/codeql-action/upload-sarif@v2 | |
| with: | |
| sarif_file: ${{ steps.slither.outputs.sarif }} |