apify-client-python/.github/workflows/_checks.yaml at master · apify/apify-client-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
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

jobs:
  actions_lint_check:
    name: Actions lint check
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v6
      - 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@v6
      - 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.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.11", "3.12", "3.13", "3.14"]'

  docstrings_check:
    name: Docstrings check
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v6

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: ${{ env.PYTHON_VERSION }}

      - name: Set up uv package manager
        uses: astral-sh/setup-uv@v7
        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

  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"]'
      operating_systems: '["ubuntu-latest", "windows-latest"]'
      python_version_for_codecov: "3.14"
      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.14"]

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

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

    steps:
      - name: Checkout repository
        uses: actions/checkout@v6

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v6
        with:
          python-version: ${{ matrix.python-version }}

      - name: Set up uv package manager
        uses: astral-sh/setup-uv@v7
        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.14' &&
            env.CODECOV_TOKEN != ''
          }}
        uses: codecov/codecov-action@v6
        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@v6

      - name: Set up uv package manager
        uses: astral-sh/setup-uv@v8.1.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.2.0
        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