Skip to content

Commit 4e784fe

Browse files
chore: revert workflow changes and add breaking changes summary to migration guide
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent a3b7334 commit 4e784fe

3 files changed

Lines changed: 18 additions & 4 deletions

File tree

.github/workflows/internal-release.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
name: Internal Release
22

33
on:
4-
workflow_dispatch:
54
push:
65
tags-ignore:
76
- '*.*'
@@ -12,7 +11,7 @@ on:
1211
- "skyflow/version.py"
1312
- "samples/**"
1413
branches:
15-
- release/v1/*
14+
- release/*
1615

1716
jobs:
1817
build-and-deploy:

.github/workflows/shared-build-and-deploy.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ jobs:
1717
build-and-deploy:
1818
runs-on: ubuntu-latest
1919
steps:
20-
- uses: actions/checkout@v4
20+
- uses: actions/checkout@v2
2121
with:
2222
fetch-depth: 0
2323

24-
- uses: actions/setup-python@v5
24+
- uses: actions/setup-python@v2
2525
- name: Install dependencies
2626
run: |
2727
python -m pip install --upgrade pip

docs/migrate_to_v2.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,21 @@
22

33
This guide outlines the steps required to migrate the Skyflow Python SDK from version 1 (v1) to version 2 (v2).
44

5+
---
6+
7+
## Breaking Changes from V1 to V2
8+
9+
| Area | V1 | V2 |
10+
|------|----|----|
11+
| **Client initialization** | `Configuration(vaultID, vaultURL, tokenProvider)` passed to `Client()` | `Credentials` + `VaultConfig` passed to `Skyflow()` |
12+
| **Vault URL** | Single `vaultURL` string | Split into `vaultId` + `clusterId` |
13+
| **Request/response types** | Raw `dict` | Typed request/response objects (e.g. `InsertRequest` / `InsertResponse`) |
14+
| **Error handling** | `SkyflowError` with basic message | Restructured with `httpStatus`, `details`, and `requestId` |
15+
| **Logging** | Global `set_log_level(LogLevel.X)` | Per-instance `logLevel` set on the `Skyflow` client |
16+
| **Import paths** | `from skyflow.vault import Client` | New module structure across all packages |
17+
18+
---
19+
520
## Authentication
621

722
In v2, multiple authentication options have been introduced. You can now provide credentials in the following ways:

0 commit comments

Comments
 (0)