ray-clickhouse 1.0__tar.gz

ray_clickhouse-1.0/.github/workflows/ci.yml

@@ -0,0 +1,379 @@
+name: CI
+
+on:
+  workflow_call:
+    inputs:
+      candidate_sha:
+        description: Immutable release candidate commit to test
+        required: false
+        type: string
+  pull_request:
+  push:
+    branches: [master]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  candidate:
+    name: Resolve candidate commit
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    outputs:
+      sha: ${{ steps.resolve.outputs.sha }}
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+          ref: ${{ github.sha }}
+      - id: resolve
+        name: Validate immutable candidate SHA
+        shell: bash
+        env:
+          INPUT_CANDIDATE_SHA: ${{ inputs.candidate_sha }}
+        run: |
+          candidate_sha="${INPUT_CANDIDATE_SHA:-${GITHUB_SHA}}"
+          if [[ ! "${candidate_sha}" =~ ^[0-9a-f]{40}$ ]]; then
+            echo "candidate_sha must be a full 40-character commit SHA" >&2
+            exit 1
+          fi
+          echo "sha=${candidate_sha}" >> "${GITHUB_OUTPUT}"
+      - name: Checkout validated candidate
+        shell: bash
+        env:
+          CANDIDATE_SHA: ${{ steps.resolve.outputs.sha }}
+        run: |
+          set -euo pipefail
+          git checkout --detach "${CANDIDATE_SHA}"
+          test "$(git rev-parse HEAD)" = "${CANDIDATE_SHA}"
+
+  unit:
+    name: Python ${{ matrix.python }} / Ray ${{ matrix.ray }}
+    needs: candidate
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - python: "3.12"
+            ray: "2.55.0"
+          - python: "3.12"
+            ray: "2.56.1"
+          - python: "3.12"
+            ray: "2.57.0"
+          - python: "3.12"
+            ray: "2.58.0"
+          - python: "3.10"
+            ray: "2.58.0"
+          - python: "3.11"
+            ray: "2.58.0"
+          - python: "3.13"
+            ray: "2.58.0"
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+          ref: ${{ needs.candidate.outputs.sha }}
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          python-version: ${{ matrix.python }}
+      - run: uv venv --python ${{ matrix.python }}
+      - run: uv pip install -e ".[dev]" "ray[data]==${{ matrix.ray }}"
+      - name: Show resolved runtime versions
+        run: >-
+          .venv/bin/python -c
+          "from importlib.metadata import version;
+          print('python=' + __import__('platform').python_version());
+          print('ray=' + version('ray'));
+          print('pyarrow=' + version('pyarrow'));
+          print('clickhouse-connect=' + version('clickhouse-connect'))"
+      - run: >-
+          .venv/bin/python -m pytest tests/unit tests/contract
+          --cov=ray_clickhouse --cov-report=term-missing
+        env:
+          RAY_ENABLE_UV_RUN_RUNTIME_ENV: "0"
+          RAY_USAGE_STATS_ENABLED: "0"
+
+  quality:
+    name: Static quality
+    needs: candidate
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+          ref: ${{ needs.candidate.outputs.sha }}
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          python-version: "3.12"
+      - run: uv sync --extra dev --group docs --frozen
+      - run: uv lock --check
+      - run: .venv/bin/ruff format --check .
+      - run: .venv/bin/ruff check .
+      - run: .venv/bin/mypy
+      - run: .venv/bin/python tools/check_compatibility.py
+      - run: .venv/bin/python tools/check_docs.py
+      - run: .venv/bin/python tools/check_release.py check
+
+  docs:
+    name: Documentation
+    needs: candidate
+    runs-on: ubuntu-24.04
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+          ref: ${{ needs.candidate.outputs.sha }}
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          python-version: "3.12"
+      - run: uv sync --extra dev --group docs --frozen
+      - run: .venv/bin/python tools/check_docs.py
+      - run: make -C doc html
+      - run: make -C doc spelling
+
+  docs-linkcheck:
+    name: Documentation links
+    needs: candidate
+    runs-on: ubuntu-24.04
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+          ref: ${{ needs.candidate.outputs.sha }}
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          python-version: "3.12"
+      - run: uv sync --extra dev --group docs --frozen
+      - run: make -C doc linkcheck
+
+  clickhouse-it:
+    name: ClickHouse 26.8 integration
+    needs: candidate
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    outputs:
+      artifact-id: ${{ steps.upload-evidence.outputs.artifact-id }}
+      artifact-digest: sha256:${{ steps.upload-evidence.outputs.artifact-digest }}
+      artifact-url: ${{ steps.upload-evidence.outputs.artifact-url }}
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+          ref: ${{ needs.candidate.outputs.sha }}
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          python-version: "3.12"
+      - run: uv sync --extra dev --frozen
+      - name: Run ClickHouse integration
+        run: ./scripts/run_clickhouse_it.sh
+        env:
+          RAY_CLICKHOUSE_IT_ARTIFACT_DIR: artifacts/it
+      - name: Upload ClickHouse integration evidence
+        id: upload-evidence
+        if: always()
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: clickhouse-26.8-integration
+          path: artifacts/it
+          if-no-files-found: error
+          retention-days: 90
+
+  ray-cluster-it:
+    name: Ray 2.58 multi-node integration
+    needs: candidate
+    runs-on: ubuntu-24.04
+    timeout-minutes: 45
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+          ref: ${{ needs.candidate.outputs.sha }}
+      - name: Run multi-node integration
+        run: ./scripts/run_ray_cluster_it.sh
+        env:
+          RAY_CLICKHOUSE_CLUSTER_IT_ARTIFACT_DIR: artifacts/it/ray-cluster
+      - name: Upload multi-node integration evidence
+        if: always()
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: ray-2.58-cluster-integration
+          path: artifacts/it/ray-cluster
+          if-no-files-found: error
+          retention-days: 90
+
+  package-build:
+    name: Build package
+    needs: candidate
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    permissions:
+      contents: read
+    outputs:
+      artifact-id: ${{ steps.upload-distributions.outputs.artifact-id }}
+      artifact-digest: sha256:${{ steps.upload-distributions.outputs.artifact-digest }}
+      artifact-url: ${{ steps.upload-distributions.outputs.artifact-url }}
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+          ref: ${{ needs.candidate.outputs.sha }}
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          python-version: "3.12"
+      - run: uv sync --extra dev --frozen
+      - run: .venv/bin/python -m build
+      - run: .venv/bin/twine check dist/*.whl dist/*.tar.gz
+      - name: Create distribution checksums
+        run: cd dist && sha256sum -- *.whl *.tar.gz > SHA256SUMS
+      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        id: upload-distributions
+        with:
+          name: distributions
+          path: dist/*
+          if-no-files-found: error
+          retention-days: 90
+
+  package-smoke:
+    name: Python ${{ matrix.python }} package smoke
+    needs: [candidate, package-build]
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - python: "3.10"
+          - python: "3.11"
+          - python: "3.12"
+          - python: "3.13"
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+          ref: ${{ needs.candidate.outputs.sha }}
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          python-version: ${{ matrix.python }}
+      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: distributions
+          path: dist
+      - run: uv venv --python ${{ matrix.python }} .venv-wheel
+      - name: Install and check wheel
+        run: |
+          shopt -s nullglob
+          (cd dist && sha256sum --check SHA256SUMS)
+          packages=(dist/*.whl)
+          test "${#packages[@]}" -eq 1
+          uv pip install \
+            --python .venv-wheel/bin/python \
+            "ray[data]==2.58.0" \
+            "${packages[0]}"
+          uv pip check --python .venv-wheel/bin/python
+          .venv-wheel/bin/python -c \
+            "from importlib.metadata import distribution, version; import clickhouse_connect, pyarrow, ray, ray_clickhouse; d = distribution('ray-clickhouse'); assert version('ray-clickhouse') == '1.0'; assert d.locate_file('ray_clickhouse/py.typed').is_file(); assert d.metadata['License-Expression'] == 'Apache-2.0'; assert d.metadata['Description-Content-Type'] == 'text/markdown'; assert 'Typing :: Typed' in d.metadata.get_all('Classifier'); print(ray.__version__)"
+      - name: Install and check source distribution
+        if: matrix.python == '3.12'
+        run: |
+          shopt -s nullglob
+          packages=(dist/*.tar.gz)
+          test "${#packages[@]}" -eq 1
+          uv venv --python 3.12 .venv-sdist
+          uv pip install \
+            --python .venv-sdist/bin/python \
+            "ray[data]==2.58.0" \
+            "${packages[0]}"
+          uv pip check --python .venv-sdist/bin/python
+          .venv-sdist/bin/python -c \
+            "from importlib.metadata import distribution, version; import clickhouse_connect, pyarrow, ray, ray_clickhouse; d = distribution('ray-clickhouse'); assert version('ray-clickhouse') == '1.0'; assert d.locate_file('ray_clickhouse/py.typed').is_file(); assert d.metadata['License-Expression'] == 'Apache-2.0'; assert d.metadata['Description-Content-Type'] == 'text/markdown'; assert 'Typing :: Typed' in d.metadata.get_all('Classifier'); print(ray.__version__)"
+
+  candidate-record:
+    name: Record release candidate
+    if: >-
+      github.event_name == 'push' &&
+      github.ref == 'refs/heads/master' &&
+      github.workflow_ref ==
+      'jiangxt2/ray-clickhouse/.github/workflows/ci.yml@refs/heads/master'
+    needs: [candidate, unit, quality, docs, docs-linkcheck, clickhouse-it, ray-cluster-it, package-build, package-smoke]
+    runs-on: ubuntu-24.04
+    timeout-minutes: 10
+    permissions:
+      actions: read
+      attestations: write
+      contents: read
+      id-token: write
+    outputs:
+      artifact-id: ${{ steps.upload-record.outputs.artifact-id }}
+      artifact-digest: sha256:${{ steps.upload-record.outputs.artifact-digest }}
+      artifact-url: ${{ steps.upload-record.outputs.artifact-url }}
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+          ref: ${{ needs.candidate.outputs.sha }}
+      - name: Download distributions by artifact ID
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          artifact-ids: ${{ needs.package-build.outputs.artifact-id }}
+          path: candidate-distributions
+          digest-mismatch: error
+      - name: Attest distributions
+        uses: actions/attest@1e69f48acb82d1966a394da916b4c1698aa569d6 # v4
+        with:
+          subject-checksums: candidate-distributions/SHA256SUMS
+      - name: Create candidate descriptor
+        env:
+          CANDIDATE_SHA: ${{ needs.candidate.outputs.sha }}
+          SOURCE_RUN_ID: ${{ github.run_id }}
+          DISTRIBUTION_ID: ${{ needs.package-build.outputs.artifact-id }}
+          DISTRIBUTION_DIGEST: ${{ needs.package-build.outputs.artifact-digest }}
+          DISTRIBUTION_URL: ${{ needs.package-build.outputs.artifact-url }}
+          EVIDENCE_ID: ${{ needs.clickhouse-it.outputs.artifact-id }}
+          EVIDENCE_DIGEST: ${{ needs.clickhouse-it.outputs.artifact-digest }}
+          EVIDENCE_URL: ${{ needs.clickhouse-it.outputs.artifact-url }}
+        run: >-
+          python3 tools/check_release.py create-candidate-record
+          --output release-candidate.json
+          --candidate-sha "${CANDIDATE_SHA}"
+          --source-run-id "${SOURCE_RUN_ID}"
+          --distribution-id "${DISTRIBUTION_ID}"
+          --distribution-digest "${DISTRIBUTION_DIGEST}"
+          --distribution-url "${DISTRIBUTION_URL}"
+          --evidence-id "${EVIDENCE_ID}"
+          --evidence-digest "${EVIDENCE_DIGEST}"
+          --evidence-url "${EVIDENCE_URL}"
+          --sha256sums candidate-distributions/SHA256SUMS
+      - name: Upload candidate descriptor
+        id: upload-record
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: release-candidate-record
+          path: release-candidate.json
+          if-no-files-found: error
+          retention-days: 90
+      - name: Record candidate identity
+        env:
+          CANDIDATE_SHA: ${{ needs.candidate.outputs.sha }}
+          SOURCE_RUN_ID: ${{ github.run_id }}
+          RECORD_ID: ${{ steps.upload-record.outputs.artifact-id }}
+          RECORD_DIGEST: sha256:${{ steps.upload-record.outputs.artifact-digest }}
+          RECORD_URL: ${{ steps.upload-record.outputs.artifact-url }}
+        run: |
+          {
+            echo "## Release candidate"
+            echo "- Candidate SHA: ${CANDIDATE_SHA}"
+            echo "- Source run ID: ${SOURCE_RUN_ID}"
+            echo "- Candidate record artifact ID: ${RECORD_ID}"
+            echo "- Candidate record artifact digest: ${RECORD_DIGEST}"
+            echo "- Candidate record artifact URL: ${RECORD_URL}"
+          } >> "${GITHUB_STEP_SUMMARY}"