coverage.yml

# This workflow runs the tests with code coverage to analyze how much
# Solidity code in the smart contracts is covered by the tests.
# It then submit the code coverage report to coveralls.io.

name: Solidity Code coverage

env:
  # 4GB of memory to prevent max heap size error when running code coverage
  NODE_OPTIONS: "--max_old_space_size=4096"

on:
  pull_request:
    branches:
      - "develop"
    types:
      - closed

jobs:
  coverage:
    runs-on: ubuntu-latest
    if: github.event.pull_request.merged == true
    steps:
      - uses: actions/checkout@v3

      - name: Use Node.js v20.x
        uses: actions/setup-node@v4
        with:
          node-version: "20.x"
          cache: "npm"

      - name: Install dependencies
        if: steps.build-cache.outputs.cache-hit != 'true'
        run: npm ci

      # This will also generate the Typechain types used by the Chai tests
      - name: Build contract artifacts
        run: npx hardhat compile

      - name: Run tests with coverage
        run: npm run test:coverage

      - name: Upload to Coveralls
        uses: coverallsapp/github-action@master
        with:
          path-to-lcov: ./coverage/lcov.info
          github-token: ${{ secrets.GITHUB_TOKEN }}