Skip to content

fix: sdk release #222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
epappas merged 2 commits into from
Nov 10, 2025
Merged

fix: sdk release #222

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
76104b7
fix: sdk release
distributedstatemachine Nov 4, 2025
72ef30f
fix: sdk release
distributedstatemachine Nov 4, 2025
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
31 changes: 23 additions & 8 deletions .github/workflows/release-python-sdk.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,23 +50,23 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
target: [x86_64, aarch64]
target: [x86_64]

@coderabbitai coderabbitai Bot Nov 4, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Breaking change: aarch64 Linux support removed without clear rationale or migration guidance.

The Linux build matrix has been restricted to x86_64 only, removing aarch64 support. This is a significant breaking change that could disrupt users on ARM-based Linux systems. The PR description provides no explanation for this change, no related issue reference, and no migration guidance.

Before approving this change, please provide:

  1. A clear rationale for removing aarch64 support (is it a build issue, maintenance burden, or intentional platform limitation?)
  2. A reference to the related issue or ADR (Architectural Decision Record) explaining this decision
  3. Updated CHANGELOG entry documenting this breaking change
  4. Migration guidance for users currently using aarch64 Linux wheels

You can verify if there's a related issue or CHANGELOG entry:

🏁 Script executed:

#!/bin/bash
# Check for related issues or PRs
gh pr view 222 --json body,labels

# Search for aarch64 references in CHANGELOG files
fd -e md -e MD CHANGELOG | xargs grep -l "aarch64" || echo "No aarch64 references found in CHANGELOG files"

# Look for recent commits related to aarch64 removal
git log --oneline --all -n 50 | grep -i "aarch64\|arm64" || echo "No recent commits mentioning aarch64/arm64"

Length of output: 2011

Breaking change requires proper documentation and rationale before merging.

Verification confirms this PR introduces a breaking change (removing aarch64 Linux support) without the necessary supporting documentation:

  • PR description is empty template text with no explanation for the removal
  • No related issue referenced
  • No CHANGELOG entry documenting the breaking change
  • No commit history explaining the decision

Required before approval:

  1. Fill PR description with actual rationale for removing aarch64 support
  2. Add CHANGELOG entry documenting this as a breaking change
  3. Reference related issue/ADR explaining the architectural decision
  4. Consider providing migration guidance for affected users
🤖 Prompt for AI Agents 
In .github/workflows/release-python-sdk.yml around line 53 the workflow was
changed to target only x86_64 which removes aarch64 Linux support; before
merging, update project documentation and metadata: replace the PR template text
with a clear rationale for removing aarch64 (who/why/impact), add a CHANGELOG
entry marking this as a breaking change with affected versions and migration
guidance, link or create an issue/ADR that records the architectural decision
and alternatives considered, and add a short note in the workflow file or commit
message referencing the issue/ADR so reviewers can verify intent.

steps:
- uses: actions/checkout@v4

- name: Install protoc
uses: arduino/setup-protoc@v3
with:
version: "25.x"
repo-token: ${{ secrets.GITHUB_TOKEN }}

- name: Build wheels
uses: PyO3/maturin-action@v1
with:
target: ${{ matrix.target }}
args: --release --out dist --manifest-path crates/basilica-sdk-python/Cargo.toml
sccache: 'true'
manylinux: auto
before-script-linux: |
# Install protoc inside the manylinux container
curl -LO https://github.com/protocolbuffers/protobuf/releases/download/v25.1/protoc-25.1-linux-x86_64.zip
unzip protoc-25.1-linux-x86_64.zip -d /usr/local
chmod +x /usr/local/bin/protoc
protoc --version

- name: Upload wheels
uses: actions/upload-artifact@v4
Expand All @@ -84,6 +84,11 @@ jobs:
steps:
- uses: actions/checkout@v4

- name: Set up Python 3.10
uses: actions/setup-python@v5
with:
python-version: '3.10'

- name: Install protoc
run: brew install protobuf

Expand All @@ -107,6 +112,11 @@ jobs:
steps:
- uses: actions/checkout@v4

- name: Set up Python 3.10
uses: actions/setup-python@v5
with:
python-version: '3.10'

- name: Install protoc
run: choco install protoc

Expand All @@ -130,6 +140,11 @@ jobs:
steps:
- uses: actions/checkout@v4

- name: Set up Python 3.10
uses: actions/setup-python@v5
with:
python-version: '3.10'

- name: Install protoc
uses: arduino/setup-protoc@v3
with:
Expand Down Expand Up @@ -259,7 +274,7 @@ jobs:

## Supported Platforms

- Linux: x86_64, aarch64 (ARM64)
- Linux: x86_64
- macOS: x86_64 (Intel), aarch64 (Apple Silicon)
- Windows: x86_64
- Python: 3.10, 3.11, 3.12, 3.13
Comment on lines 275 to 280

@coderabbitai coderabbitai Bot Nov 4, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Release notes need breaking-change highlight for aarch64 removal.

The release notes correctly show "Linux: x86_64" but lack any callout that aarch64 Linux support has been removed. Users on ARM-based Linux systems will see this without explanation.

Recommendation: Add a "⚠️ Breaking Changes" section to the release body (around line 282, before or after "What's Changed") highlighting aarch64 Linux removal and offering migration guidance or alternatives.

🤖 Prompt for AI Agents 
.github/workflows/release-python-sdk.yml around lines 275–280: the release notes
list supported platforms but omit a prominent notice that Linux aarch64 support
was removed; add a "⚠️ Breaking Changes" section near line 282 (before or after
"What's Changed") that clearly states the removal of aarch64 Linux support,
explains impact on ARM-based Linux users, and provides brief migration guidance
or alternatives (e.g., use x86_64 builds under emulation, run on supported
x86_64 hardware, or contact support/roadmap for aarch64 reinstatement).

Expand Down
Loading