_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 unit test suite.
        required: false
        type: boolean
        default: true

permissions:
  contents: read

env:
  NODE_VERSION: 24

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

  spell_check:
    name: Spell check
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v7
      - name: Check spelling with typos
        uses: crate-ci/typos@v1

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

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

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

      - name: Set up Node
        uses: actions/setup-node@v6
        with:
          node-version: ${{ env.NODE_VERSION }}

      - name: Install pnpm and website dependencies
        uses: apify/actions/pnpm-install@v1.2.0
        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@v7

      - name: Set up Node
        uses: actions/setup-node@v6
        with:
          node-version: ${{ env.NODE_VERSION }}

      - name: Install pnpm and website dependencies
        uses: apify/actions/pnpm-install@v1.2.0
        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@v7
        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@v47
        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.10", "3.11", "3.12", "3.13", "3.14"]'
      operating_systems: '["ubuntu-latest", "windows-latest", "macos-latest"]'
      python_version_for_codecov: "3.14"
      operating_system_for_codecov: ubuntu-latest
      tests_concurrency: "8"

  package_check:
    name: Package check
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v7

      - name: Set up uv package manager
        uses: astral-sh/setup-uv@v8.2.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.3.0
        with:
          package_name: crawlee
          dist_dir: dist
          python_version: "3.14"
          extras: all
          smoke_code: |
            from crawlee.crawlers import (
                HttpCrawler, BeautifulSoupCrawler, ParselCrawler,
                PlaywrightCrawler, AdaptivePlaywrightCrawler,
            )
            from crawlee.storages import Dataset, KeyValueStore, RequestQueue
            from crawlee.http_clients import HttpxHttpClient, ImpitHttpClient
            from crawlee import Request
            HttpCrawler()
            BeautifulSoupCrawler()
            ParselCrawler()

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