checks.yml

name: checks

on:
  push:
    branches: [main]
  pull_request: {}
  workflow_dispatch: {}


env:
  FOUNDRY_PROFILE: ci

jobs:
  lint:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
      with:
        submodules: recursive

    - name: Setup Node environment
      uses: ./.github/actions/setup

    - name: Run linter
      run: yarn lint

  docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: recursive

      - name: Setup Node environment
        uses: ./.github/actions/setup

      - name: Install Foundry
        uses: foundry-rs/foundry-toolchain@v1

      - name: Check if docs are up to date
        run: yarn docgen:test

  tests:
    strategy:
      fail-fast: true

    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: recursive

      - name: Setup Node environment
        uses: ./.github/actions/setup

      - name: Install Foundry
        uses: foundry-rs/foundry-toolchain@v1

      - name: Run Forge version
        run: |
          forge --version
        id: version

      - name: Run tests
        run: |
          yarn test
        id: test

  dispatch:
    runs-on: ubuntu-latest
    needs: [lint, docs, tests]
    if: success()
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: recursive
          fetch-depth: 2

      - name: Check for changes in the `docs/` folder
        id: check_changes
        run: |
          git fetch origin main
          [ -n "$(git diff --name-only HEAD^ HEAD -- docs/)" ] && echo "SHOULD_TRIGGER_DOC_UPDATE=true" >> $GITHUB_ENV || true

      - name: Trigger repository_dispatch
        if: env.SHOULD_TRIGGER_DOC_UPDATE == 'true'
        run: |
          curl -X POST \
            -H "Accept: application/vnd.github.v3+json" \
            -H "Authorization: token ${{ secrets.OZ_UPGRADE_TRIGGER_TOKEN }}" \
            https://api.github.com/repos/OpenZeppelin/openzeppelin-upgrades/dispatches \
            -d '{"event_type":"update-foundry-submodule-docs"}'