opendal/.github/workflows/ci_bindings_python.yml at main · apache/opendal · 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
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

name: Bindings Python CI

on:
  push:
    branches:
      - main
    paths: &paths
      - ".github/actions/setup/**"
      - ".github/workflows/ci_bindings_python.yml"
      - "bindings/python/**"
      - "core/**"
  pull_request:
    branches:
      - main
    paths: *paths
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event_name }}
  cancel-in-progress: true

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7

      - name: Setup Rust toolchain
        uses: ./.github/actions/setup

      - name: Install uv
        uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
        with:
          working-directory: "bindings/python"

      - uses: taiki-e/install-action@just

      # Useful for debugging
      - name: Print Clippy version
        working-directory: "bindings/python"
        run: cargo clippy --version

      - name: Run Lints
        working-directory: "bindings/python"
        run: just lint

  stubs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7

      - name: Setup Rust toolchain
        uses: ./.github/actions/setup

      - name: Install uv
        uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
        with:
          working-directory: "bindings/python"

      - uses: taiki-e/install-action@just

      - name: Setup taplo
        uses: taiki-e/install-action@v2
        with:
          tool: taplo-cli

      - name: Install Hawkeye
        uses: taiki-e/install-action@v2
        with:
          tool: hawkeye@7.2.0

      - name: Regenerate stubs
        working-directory: "bindings/python"
        run: just stub-gen

      - name: Check diff
        run: git diff --exit-code

  examples:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7

      - name: Setup Rust toolchain
        uses: ./.github/actions/setup
        with:
          need-protoc: true
          github-token: ${{ secrets.GITHUB_TOKEN }}

      - name: Setup uv
        uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
        with:
          working-directory: bindings/python

      - name: Build with maturin
        shell: bash
        working-directory: "bindings/python"
        run: |
          uv venv --python=python3.11
          uv sync --all-extras
          uv run -- maturin develop

      # Examples back the snippets shown in the website guide. Running them keeps
      # the docs honest: a broken example fails CI instead of shipping bad docs.
      - name: Run guide examples
        shell: bash
        working-directory: "bindings/python"
        run: uv run -- python examples/getting_started.py