checks.yml

name: CI Checks

on:
  push:
    branches:
      - main
  pull_request:

jobs:
  formatting:
    runs-on: ubuntu-20.04

    # In order to trigger other workflows after committing formatting changes, we need
    # to use the PR Automation App. This secret is not available for external
    # contributors. So on PRs that can't access the secret, we don't commit changes and 
    # instead just fail if the formatting changes are needed.
    steps:
      - name: Check if commits can be added
        id: check_can_add_commit
        run: |
          echo "can_add_commit=${{ secrets.PR_AUTOMATION_BOT_PUBLIC_PRIVATE_KEY != '' && github.event_name == 'pull_request' }}" >> $GITHUB_OUTPUT

      - name: Create GitHub App Token
        uses: actions/create-github-app-token@v1
        id: app-token
        with:
          app-id: ${{ vars.PR_AUTOMATION_BOT_PUBLIC_APP_ID }}
          private-key: ${{ secrets.PR_AUTOMATION_BOT_PUBLIC_PRIVATE_KEY }}

      - name: Checkout
        if: steps.check_can_add_commit.outputs.can_add_commit == 'true'
        uses: actions/checkout@v4
        with:
          repository: ${{ github.event.pull_request.head.repo.full_name }}
          ref: ${{ github.event.pull_request.head.ref }}
          token: ${{ steps.app-token.outputs.token }}
      - name: Checkout
        if: steps.check_can_add_commit.outputs.can_add_commit == 'false'
        uses: actions/checkout@v4

      - name: Install shfmt
        run: sudo snap install --classic shfmt
      - name: Format shell scripts
        run: ./scripts/fmt-sh

      - name: Install ts dependencies
        run: npm ci
      - name: Format ts
        run: npm run format

      - name: Check formatting changes
        id: check_format
        run: |
          if git diff --exit-code; then
            echo "formatting_needed=false" >> $GITHUB_OUTPUT
          else
            echo "formatting_needed=true" >> $GITHUB_OUTPUT
          fi
      - name: Commit Formatting changes
        if: steps.check_can_add_commit.outputs.can_add_commit == 'true' && steps.check_format.outputs.formatting_needed == 'true'
        uses: EndBug/add-and-commit@v9.1.4
        with:
          add: .
          default_author: github_actions
          message: "Updating formatting"
          # do not pull: if this branch is behind, then we might as well let
          # the pushing fail
          pull_strategy: "NO-PULL"

      - name: Fail for formatting issues without GitHub App
        if: steps.check_can_add_commit.outputs.can_add_commit == 'false' && steps.check_format.outputs.formatting_needed == 'true'
        run: |
          echo "Formatting changes are needed but couldn't be committed because the GitHub App secret isn't available or this isn't a pull request."
          exit 1

  build-candid:
    runs-on: ubuntu-20.04

    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Install didc
        run: |
          mkdir -p .bin
          curl -L https://github.com/dfinity/candid/releases/download/2024-02-27/didc-linux64 > .bin/didc
          chmod +x .bin/didc
      - name: Add didc to the PATH
        run: echo "${PWD}/.bin" >> $GITHUB_PATH
      - name: Install ts dependencies
        run: npm ci --include=dev
      - name: Compile candid
        run: ./scripts/compile-idl-js
      - name: Verify that there are no changes to the compiled did files
        run: git diff --exit-code -- candid/

  build-protobuf:
    runs-on: ubuntu-20.04

    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Check the protoc installer
        run: ./scripts/install-protoc --help
      - name: Install protoc
        run: sudo ./scripts/install-protoc
      - name: Install ts dependencies
        run: npm ci --include=dev
      - name: Compile protobuf
        run: npm run protoc
      - name: Verify that there are no changes to the compiled proto files
        run: git diff --exit-code -- packages/nns/proto/

  build:
    needs: [build-candid, build-protobuf]
    runs-on: ubuntu-20.04

    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Install dependencies
        run: npm ci
      - name: Build
        run: npm run build --workspaces

  lint:
    runs-on: ubuntu-20.04

    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Install dependencies
        run: npm ci
      - name: Lint
        run: npm run lint

  test:
    runs-on: ubuntu-20.04

    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Install dependencies
        run: npm ci
      - name: Build
        run: npm run build --workspaces
      - name: Test
        run: npm run test --workspaces

  size:
    runs-on: ubuntu-20.04
    # The size checker should run and provide metrics only on PRs
    if: ${{ github.ref != 'refs/heads/main' }}

    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Size check
        # The limits are defined in package.json.
        uses: andresz1/size-limit-action@v1
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}

  may-merge:
    needs: ["formatting", "build", "lint", "test", "size"]
    runs-on: ubuntu-20.04
    steps:
      - name: Cleared for merging
        run: echo OK