Add docs and go bindings checks to CI workflow #583
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: | |
| pull_request: | |
| push: | |
| jobs: | |
| lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: "20" | |
| - name: Install dependencies | |
| run: yarn install --frozen-lockfile | |
| - name: Lint | |
| run: yarn lint:prettier | |
| test: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: "20" | |
| - name: Install dependencies | |
| run: yarn install --frozen-lockfile | |
| - name: Run Tests | |
| run: yarn test | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: "20" | |
| - name: Install dependencies | |
| run: yarn install --frozen-lockfile | |
| - name: Generate docs | |
| run: yarn docgen | |
| - name: Check if docs are up to date | |
| run: | | |
| # Check if docgen generated docs that are uncommitted | |
| if [ -n "$(git status --porcelain)" ]; then | |
| echo "❌ Generated docs are not up to date. Please run yarn docgen and commit the changes." | |
| git status --porcelain | |
| git diff --color | |
| exit 1 | |
| else | |
| echo "✅ Generated docs are up to date." | |
| fi | |
| go-bindings: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: "20" | |
| - name: Generate go-bindings | |
| run: | | |
| # Generate go-bindings | |
| bash scripts/generate_go_abi.sh | |
| - name: Check if go-bindings are up to date | |
| run: | | |
| # Check if go-bindings are up to date | |
| if [ -n "$(git status --porcelain)" ]; then | |
| echo "❌ Generated go-bindings are not up to date. Please run scripts/generate_go_abi.sh and commit the changes." | |
| git status --porcelain | |
| exit 1 | |
| else | |
| echo "✅ Generated go-bindings are up to date." | |
| fi | |
| coverage: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: "20" | |
| - name: Install dependencies | |
| run: yarn install --frozen-lockfile | |
| - name: Run hardhat coverage | |
| run: yarn hardhat coverage | |
| - name: Check coverage threshold | |
| run: | | |
| COV_THRESHOLD=85 | |
| # Extract total lines and covered lines | |
| TOTAL_LINES=$(cat coverage/lcov.info | grep 'LF:' | awk -F':' '{sum += $2} END {print sum}') | |
| COVERED_LINES=$(cat coverage/lcov.info | grep 'LH:' | awk -F':' '{sum += $2} END {print sum}') | |
| # Calculate coverage only if there are lines to test | |
| if [ "$TOTAL_LINES" -gt 0 ]; then | |
| COVERAGE=$(echo "scale=2; $COVERED_LINES * 100 / $TOTAL_LINES" | bc) | |
| echo "Total lines: $TOTAL_LINES" | |
| echo "Covered lines: $COVERED_LINES" | |
| echo "Total coverage: ${COVERAGE}%" | |
| # Check if coverage is below threshold | |
| if (( $(echo "$COVERAGE < $COV_THRESHOLD" | bc -l) )); then | |
| echo "Coverage is below threshold: ${COV_THRESHOLD}%" | |
| exit 1 | |
| fi | |
| else | |
| echo "No lines to test found in coverage report" | |
| exit 1 | |
| fi | |
| - name: Save coverage report | |
| if: always() | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: coverage-report | |
| path: coverage/ | |
| retention-days: 90 |