_checks.yaml

name: Checks

on:
  # Runs when invoked by another workflow. For manual runs, dispatch `CI (master)` instead — that wraps this
  # workflow via `uses:`, so the resulting check-run names get the `Checks /` prefix that the manual release
  # workflows look for via `wait-for-checks`.
  workflow_call:
    inputs:
      run_tests:
        description: Whether to run the test suites (unit, integration).
        required: false
        type: boolean
        default: true

permissions:
  contents: read

env:
  PYTHON_VERSION: 3.14
  NODE_VERSION: 24

jobs:
  actions_lint_check:
    name: Actions lint check
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      - name: Run actionlint
        uses: rhysd/actionlint@914e7df21a07ef503a81201c76d2b11c789d3fca # v1.7.12

  spell_check:
    name: Spell check
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      - name: Check spelling with typos
        uses: crate-ci/typos@7f9d0819ca1c008ade73f4b41fa9d258d48f605b # v1.51.1

  lint_check:
    name: Lint check
    uses: apify/workflows/.github/workflows/python_lint_check.yaml@main
    with:
      python_versions: '["3.11", "3.12", "3.13", "3.14", "3.15"]'

  type_check:
    name: Type check
    uses: apify/workflows/.github/workflows/python_type_check.yaml@main
    with:
      python_versions: '["3.11", "3.12", "3.13", "3.14", "3.15"]'

  docstrings_check:
    name: Docstrings check
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - name: Set up Python
        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
        with:
          python-version: ${{ env.PYTHON_VERSION }}

      - name: Set up uv package manager
        uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
        with:
          python-version: ${{ env.PYTHON_VERSION }}

      - name: Install dependencies
        run: uv run poe install-dev

      - name: Async docstrings check
        run: uv run poe check-docstrings

  markdown_lint_check:
    name: Markdown lint check
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - name: Set up Node
        uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
        with:
          node-version: ${{ env.NODE_VERSION }}

      - name: Install pnpm and website dependencies
        uses: apify/actions/pnpm-install@v1.6.2
        with:
          working-directory: website

      - name: Lint Markdown
        run: pnpm lint:md
        working-directory: website

  website_lint_check:
    name: Website lint check
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - name: Set up Node
        uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
        with:
          node-version: ${{ env.NODE_VERSION }}

      - name: Install pnpm and website dependencies
        uses: apify/actions/pnpm-install@v1.6.2
        with:
          working-directory: website

      - name: Lint website code
        run: pnpm lint:code
        working-directory: website

      - name: Check website formatting
        run: pnpm format:check
        working-directory: website

  image_lint_check:
    name: Image lint check
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 0

      # Doc images must be committed as optimized `.webp`. This fails when a PR adds raster
      # images in another format so they get converted via `pnpm opt:images` first.
      - name: Get changed unoptimized images
        id: changed-files
        uses: tj-actions/changed-files@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6
        with:
          files: |
            docs/**/*.{png,jpg,jpeg,gif,bmp,tif,tiff,avif}
            website/static/**/*.{png,jpg,jpeg,gif,bmp,tif,tiff,avif}
          separator: "\n"

      - name: Fail on unoptimized images
        if: steps.changed-files.outputs.any_changed == 'true'
        env:
          UNOPTIMIZED_IMAGE_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
        run: |
          echo "Unoptimized images detected! Convert each one to WebP, e.g.:"
          echo ""
          while IFS= read -r file_path; do
            echo "  (cd website && pnpm opt:images \"../$file_path\")"
          done <<< "$UNOPTIMIZED_IMAGE_FILES"
          echo ""
          echo "Then reference the resulting .webp files in your Markdown."
          exit 1

  unit_tests:
    name: Unit tests
    if: inputs.run_tests
    uses: apify/workflows/.github/workflows/python_unit_tests.yaml@main
    secrets: inherit
    with:
      python_versions: '["3.11", "3.12", "3.13", "3.14", "3.15"]'
      operating_systems: '["ubuntu-latest", "windows-latest"]'
      python_version_for_codecov: "3.15"
      operating_system_for_codecov: ubuntu-latest
      tests_concurrency: "16"

  # Integration tests are inlined (not calling the reusable workflow) to avoid GitHub's compile-time secret
  # validation for nested reusable workflows, which fails on fork PRs where repo secrets are not available.
  integration_tests:
    name: Integration tests (${{ matrix.python-version }}, ${{ matrix.os }})
    if: >-
      ${{
        inputs.run_tests && (
          (github.event_name == 'pull_request' && github.event.pull_request.head.repo.owner.login == 'apify') ||
          (github.event_name == 'push' && github.ref == 'refs/heads/master') ||
          github.event_name == 'workflow_dispatch'
        )
      }}

    strategy:
      matrix:
        os: [ubuntu-latest]
        python-version: ["3.11", "3.15"]

    runs-on: ${{ matrix.os }}

    env:
      TESTS_CONCURRENCY: "16"
      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

    steps:
      - name: Checkout repository
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
        with:
          python-version: ${{ matrix.python-version }}

      - name: Set up uv package manager
        uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
        with:
          python-version: ${{ matrix.python-version }}

      - name: Install Python dependencies
        run: uv run poe install-dev

      - name: Run integration tests
        run: uv run poe integration-tests-cov
        env:
          APIFY_TEST_USER_API_TOKEN: ${{ secrets.APIFY_TEST_USER_PYTHON_SDK_API_TOKEN }}
          APIFY_TEST_USER_2_API_TOKEN: ${{ secrets.APIFY_TEST_USER_2_API_TOKEN }}

      - name: Upload integration test coverage
        if: >-
          ${{
            matrix.os == 'ubuntu-latest' &&
            matrix.python-version == '3.15' &&
            env.CODECOV_TOKEN != ''
          }}
        uses: codecov/codecov-action@303a32d7a59b442fa8d48b6a1cc6825c09c847a5 # v7.1.1
        with:
          token: ${{ env.CODECOV_TOKEN }}
          files: coverage-integration.xml
          flags: integration

  package_check:
    name: Package check
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - name: Set up uv package manager
        uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
        with:
          python-version: "3.14"

      - name: Build sdist and wheel
        run: uv run poe build

      - name: Verify built package
        uses: apify/actions/python-package-check@v1.6.2
        with:
          package_name: apify_client
          dist_dir: dist
          python_version: "3.14"
          smoke_code: |
            from apify_client import ApifyClient, ApifyClientAsync
            ApifyClient(token='x')
            ApifyClientAsync(token='x')

  doc_check:
    name: Doc check
    uses: apify/workflows/.github/workflows/python_docs_check.yaml@main