Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 116 additions & 0 deletions .github/workflows/python-client-build-artifacts.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
#
# 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: "Python Client Build Artifacts"

on:
workflow_dispatch:
inputs:
version:
description: 'Version to set (optional, e.g. 1.1.0 or 1.1.0rc1 or dev-20251202-abc1234)'
type: string
required: false
workflow_call:
inputs:
version:
description: 'Version to set (optional)'
type: string
required: false
pull_request:
paths:
- '.github/workflows/python-client-build-artifacts.yml'
- 'client/python/**'
Comment on lines +23 to +38
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought this WF is just for nightly builds?
I'm confused about the need for a "version" input and that the WF is triggered by PRs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The version here is optional and used to set the package version here

      - name: Set version (if provided)
        if: inputs.version != ''
        env:
          VERSION: ${{ inputs.version }}
        run: make client-set-version VERSION="${{ env.VERSION }}"

In the nightly build, we will need to determine a convention of the package version for nightly build, such as including commit hash/date to the package version, so we could have a better reference in test.pypi.org. But IMHO the details of the version we want to set to the package could be determined in the actual nightly build publication step. This workflow should focus on building all the wheels required, by default leave the package version unchanged and make it an option for any upstream caller to set the version as needed. WDYT?


jobs:
build-artifacts:
name: Build artifacts on ${{ matrix.os }} with Python ${{ matrix.python-version }}
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ ubuntu-24.04, macos-14, macos-15] # current build script is not compatible with windows
Comment on lines +44 to +46
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there anything that's performance critical in the Python package?
I'd prefer to not build native code.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, ideally we only need a universal wheel since everything is pure python. However, since we need to leverage a custom build script to do open api client generation, poetry thinks it needs to generate platform-specific wheels. This is a known limitation and seems we have no native way to override this behavior now.

Should the situation changed in the future, we should definitely switch to universal wheel if possible.

python-version: [ "3.10", "3.11", "3.12", "3.13" ]

steps:
- uses: actions/checkout@v5
with:
fetch-depth: 1

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

- name: Set up JDK for openapi-generator-cli
uses: actions/setup-java@dded0888837ed1f317902acf8a20df0ad188d165 # v5
with:
distribution: 'temurin'
java-version: '21'

- name: Set version (if provided)
if: inputs.version != ''
env:
VERSION: ${{ inputs.version }}
run: make client-set-version VERSION="${{ env.VERSION }}"

- name: Build source distribution
if: matrix.python-version == '3.13' && startsWith(matrix.os, 'ubuntu-24.04')
run: |
make client-build FORMAT=sdist

- name: Build wheel
run: |
make client-build FORMAT=wheel

- name: Prepare artifacts directory
run: |
mkdir -p wheelhouse
cp ./client/python/dist/*.whl wheelhouse/

- name: Add source distribution
if: matrix.python-version == '3.13' && startsWith(matrix.os, 'ubuntu-24.04')
run: cp ./client/python/dist/*.tar.gz wheelhouse/

- uses: actions/upload-artifact@v4
with:
name: "python-client-artifacts-${{ matrix.os }}-py${{ matrix.python-version }}"
path: ./wheelhouse/*

merge-artifacts:
runs-on: ubuntu-latest
needs:
- build-artifacts
steps:
- name: Generate artifact name
id: artifact-name
run: |
if [ -n "${{ inputs.version }}" ]; then
ARTIFACT_NAME="python-client-artifacts-${{ inputs.version }}"
Comment on lines +102 to +103
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the reason for this special case?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It could make the output zip file name indicate that a custom version has been provided hence the built sdist and wheels will have its package version changed. Just for convenience.

else
ARTIFACT_NAME="python-client-artifacts-${{ github.run_id }}"
fi
echo "ARTIFACT_NAME=$ARTIFACT_NAME" >> $GITHUB_OUTPUT
echo "Using artifact name: $ARTIFACT_NAME"

- name: Merge Artifacts
uses: actions/upload-artifact/merge@v4
with:
name: ${{ steps.artifact-name.outputs.ARTIFACT_NAME }}
pattern: python-client-artifacts-*
delete-merged: true

10 changes: 10 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,16 @@ client-lint: client-setup-env ## Run linting checks for Polaris client
@$(ACTIVATE_AND_CD) && poetry run pre-commit run --files integration_tests/* python/cli/*
@echo "--- Client linting checks complete ---"

.PHONY: client-set-version
client-set-version: client-setup-env ## Set Python client version using poetry. Usage: make client-set-version VERSION=<version>
@echo "--- Setting client version ---"
@if [ -z "$(VERSION)" ]; then \
echo "Error: VERSION is required. Usage: make client-set-version VERSION=<version>" >&2; \
exit 1; \
fi
@$(ACTIVATE_AND_CD) && poetry version "$(VERSION)"
@echo "--- Client version set to $(VERSION) ---"

.PHONY: client-regenerate
client-regenerate: client-setup-env ## Regenerate the client code
@echo "--- Regenerating client code ---"
Expand Down