action.yml

name: "Raster Batch Runner"
description: >-
  Run a declarative raster processing job (clip, reproject, resample, mosaic,
  mask, COG conversion) across a folder of imagery, in parallel and resumably.
author: "python-remote-sensing.com"

branding:
  icon: layers
  color: green

inputs:
  job:
    description: "Path to the YAML job spec to run."
    required: true
  workers:
    description: "Worker processes. Defaults to the runner's CPU count."
    required: false
    default: ""
  timeout:
    description: "Per-file timeout in seconds. Empty means no timeout."
    required: false
    default: ""
  extra-args:
    description: >-
      Additional flags passed straight to `raster-batch run`, e.g.
      "--retry-failed" or "--force --limit 50".
    required: false
    default: ""
  python-version:
    description: "Python version to set up. rasterio needs 3.12 or newer."
    required: false
    default: "3.12"
  state-file:
    description: >-
      Ledger location. Point this at a cached path to make a job resumable
      across workflow runs.
    required: false
    default: ""
  fail-on-error:
    description: >-
      Fail the step if any file failed. Set to "false" to keep going and
      inspect the summary output yourself.
    required: false
    default: "true"

outputs:
  summary:
    description: "The full run summary as a JSON string."
    value: ${{ steps.run.outputs.summary }}
  completed:
    description: "Number of files processed in this run."
    value: ${{ steps.run.outputs.completed }}
  skipped:
    description: "Number of files skipped because they were already done."
    value: ${{ steps.run.outputs.skipped }}
  failed:
    description: "Number of files that failed."
    value: ${{ steps.run.outputs.failed }}

runs:
  using: composite
  steps:
    - name: Set up Python
      uses: actions/setup-python@v6
      with:
        python-version: ${{ inputs.python-version }}
        cache: pip

    - name: Install dependencies
      shell: bash
      run: python -m pip install --upgrade pip -r "${{ github.action_path }}/requirements.txt"

    - name: Validate the job spec
      shell: bash
      env:
        PYTHONPATH: ${{ github.action_path }}
      run: python -m raster_batch validate "${{ inputs.job }}"

    - name: Run the job
      id: run
      shell: bash
      env:
        PYTHONPATH: ${{ github.action_path }}
      run: |
        set -o pipefail
        args=()
        [ -n "${{ inputs.workers }}" ] && args+=(--workers "${{ inputs.workers }}")
        [ -n "${{ inputs.timeout }}" ] && args+=(--timeout "${{ inputs.timeout }}")
        [ -n "${{ inputs.state-file }}" ] && args+=(--state "${{ inputs.state-file }}")
        # shellcheck disable=SC2206
        [ -n "${{ inputs.extra-args }}" ] && args+=(${{ inputs.extra-args }})

        set +e
        python -m raster_batch run "${{ inputs.job }}" --json "${args[@]}" > summary.json
        status=$?
        set -e

        cat summary.json

        {
          echo "summary<<RASTER_BATCH_EOF"
          cat summary.json
          echo "RASTER_BATCH_EOF"
        } >> "$GITHUB_OUTPUT"

        python - <<'PY' >> "$GITHUB_OUTPUT"
        import json
        with open("summary.json") as handle:
            data = json.load(handle)
        for key in ("completed", "skipped", "failed"):
            print(f"{key}={data.get(key, 0)}")
        PY

        python - <<'PY' >> "$GITHUB_STEP_SUMMARY"
        import json
        with open("summary.json") as handle:
            data = json.load(handle)
        print("## Raster batch run\n")
        print(f"- Completed: {data.get('completed', 0)}")
        print(f"- Skipped: {data.get('skipped', 0)}")
        print(f"- Failed: {data.get('failed', 0)}")
        print(f"- Elapsed: {data.get('elapsed_seconds', 0)}s")
        failures = data.get("failures") or []
        if failures:
            print("\n### Failures\n")
            for failure in failures:
                print(f"- `{failure['unit']}`: {failure['error']}")
        PY

        if [ "${{ inputs.fail-on-error }}" = "true" ]; then
          exit $status
        fi