rippled/.github/workflows/check-levelization.yml

# This workflow checks if the dependencies between the modules are correctly
# indexed.
name: Levelization

# This workflow can only be triggered by other workflows.
on:
  workflow_call:
    inputs:
      runner:
        description: 'An optional string representing the GitHub runner to use.'
        required: true
        type: string

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

defaults:
  run:
    shell: bash

jobs:
  levelization:
    runs-on: ${{ inputs.runner }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
      - name: Check levelization
        run: Builds/levelization/levelization.sh
      - name: Check for differences
        env:
          MESSAGE: |

            The dependency relationships between the modules in rippled have
            changed, which may be an improvement or a regression.

            A rule of thumb is that if your changes caused something to be
            removed from loops.txt, it's probably an improvement, while if
            something was added, it's probably a regression.

            Run './Builds/levelization/levelization.sh' in your repo, and then
            commit and push the changes. See Builds/levelization/README.md for
            more info.
        run: |
          DIFF=$(git status --porcelain)
          if [ -n "${DIFF}" ]; then
            # Print the differences to give the contributor a hint about what to
            # expect when running levelization on their own machine.
            git diff
            echo "${MESSAGE}"
            exit 1
          fi