Skip to content

Remove standalone API releases and SDK nightly publishing - #88

Open
aaron-kumo wants to merge 3 commits into
mainfrom
aaron/remove-kumo-api-release
Open

aaron-kumo wants to merge 3 commits into
mainfrom
aaron/remove-kumo-api-release

Conversation

@aaron-kumo

@aaron-kumo aaron-kumo commented Oct 21, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

kumo-engine bundles kumo-api; future kumo-studio-client publishing will use a new pipeline. This PR removes the standalone API release pipeline and the SDK nightly publisher:

  • Deletes the API release and hotfix workflows, their release planner and schema compatibility tooling, and the release-check extra.
  • Deletes the scheduled and manually dispatched SDK nightly publisher and its test assertions. SDK wheel builds and tests retain their colocated API installation.
  • Removes the inactive schema-compat job.
  • Trims the package README.

Change map

File-by-file change map.

Testing Done

  • API tests: 1,106 passed on Python 3.11.
  • SDK release-artifact tests: 9 passed.
  • ty==0.0.77, uv lock --check, documentation, public-reference, workflow security, and whitespace checks pass.

Checklist

  • Breaking changes: removes standalone kumo-api release automation and SDK nightly publishing.
  • Updated package documentation; migration-note removal stays in Replace import records with a code provenance page #86.
  • Removed the release planner's test and nightly-specific assertions; retained package and release-artifact tests pass.

@aaron-kumo

aaron-kumo commented Oct 21, 2026 •

Copy link
Copy Markdown
Collaborator Author

Change map

  • Requirement: kumo-engine bundles kumo-api; future kumo-studio-client publishing will use a new pipeline.
  • Existing behavior: two manually dispatched workflows can publish kumo-api to PyPI, push version bumps to master, and upload its schema to S3 with an AWS role. This repository has never used them (no kumo-api-v* branches or tags).
  • Smallest sufficient change: remove the standalone API release workflows, their tooling and dependency extra, and the SDK nightly publisher; retain SDK wheel validation with colocated API builds and trim the package README.
  • Verification: after rebasing onto main 70637d30816, 1,106 kumo-api tests and 9 SDK release-artifact tests pass locally. The pinned API type checker (ty==0.0.77), uv lock --check, workflow security, documentation, public-reference, and whitespace checks pass. Main's existing API typing fix is retained.
  • Stopping condition: the standalone API publisher and SDK nightly publisher are removed; API validation and SDK wheel validation remain intact.
File Function / scope What changed Why
.github/workflows/kumo-api-release.yml, .github/workflows/kumo-api-hotfix-release.yml Deleted Release and hotfix workflows (PyPI publish, GitHub release, S3 schema check and upload). kumo-api isn't released separately.
packages/kumo-api/tools/__init__.py, packages/kumo-api/tools/release_plan.py, packages/kumo-api/tools/schema_compat/__init__.py, packages/kumo-api/tools/schema_compat/__main__.py, packages/kumo-api/tools/schema_compat/cli.py, packages/kumo-api/tools/schema_compat/comparator.py, packages/kumo-api/tools/schema_compat/config.py, packages/kumo-api/tools/schema_compat/extractor.py, packages/kumo-api/tools/schema_compat/models.py, packages/kumo-api/tools/schema_compat/rules.py, packages/kumo-api/tools/schema_compat/storage.py, packages/kumo-api/test/test_release_plan.py Deleted Release planner, schema compatibility tool, and the planner's test. Only the deleted workflows used them.
.github/workflows/kumo-api-testing.yml schema-compat job Removed. It only read the version; its check was commented out.
.github/workflows/kumo-api-lint.yml ty job Installs .[test]. release-check is removed.
packages/kumo-api/pyproject.toml Optional dependencies; package discovery Removes release-check and the tools* exclude. Only the release tooling used them.
uv.lock kumo-api entry Drops the release-check extra. Follows pyproject.toml; no package versions change.
packages/kumo-api/README.md Package overview and development Summarizes the package and engine bundling, retains test commands without release-check, and drops obsolete SDK guidance and the migration pointer. Keep current package guidance concise; #86 owns deleting MIGRATION.md.
packages/kumo-api/.github/actions/verify-import/action.yml install-extras input description Removes the release-check example. The extra is removed.
scripts/check_public_references.py IDENTIFIER_RULE_EXEMPT_PREFIXES Removes the schema tool's config path. The file is deleted.
.github/workflows/kumo-sdk-release-nightly.yml Deleted Removes the scheduled and manually dispatched nightly SDK publisher. SDK distribution belongs to the replacement client pipeline; the nightly wheel requires a separately published API dependency.
packages/kumo-sdk/test/test_release_artifact.py test_publication_keeps_s3_out_of_the_public_path Removes the deleted nightly workflow read and its two assertions. Keep artifact and tagged-publication checks scoped to retained workflows.

@copy-pr-bot

copy-pr-bot Bot commented Oct 21, 2026

Copy link
Copy Markdown

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@aaron-kumo
aaron-kumo temporarily deployed to gha-kumo-workflow-tests October 21, 2026 20:43 — with GitHub Actions Inactive
@coderabbitai

coderabbitai Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

Files ignored due to path filters: 1
  • uv.lock is excluded by !**/*.lock, !**/*.lock
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 066772f and 5a883c7.

Files ignored due to path filters: 1
  • uv.lock is excluded by !**/*.lock, !**/*.lock

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • Trigger review

No actionable comments were generated in the recent review.

Walkthrough

The changes remove the Kumo API release workflows and release-planning code. They also remove the schema compatibility toolchain and its testing workflow job. Package metadata, documentation, and workflow references to the removed release-check extra were updated. The from_json call remains unchanged, with an added comment and type-checker annotation. The Kumo SDK nightly release workflow and its publication-test checks were removed.

Merge Risk: Minimal · previous review 06677

No issue requiring a change before merge is established by the supplied evidence. Normal checks remain appropriate.

Pre-merge checks: Passed 2 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Change Map Design Review Warning The change map is incomplete and misleading about standalone distribution. The PR deletes both Kumo API PyPI workflows, but the retained kumo-sdk-release-on-tag.yml still publishes kumoai-studio. … Retain an API publication path until all SDK release paths are replaced, or change the SDK release/package design so it does not require an independently published exact kumo-api version. If the retained SDK release path is obsolete, remo…
Passed Passed checks: 2 passed
Check name Status Explanation
Pr Size Passed The pull request changes 24 files. The custom check fails only when the count exceeds 40, so this pull request passes.
Public Resource Access Passed No added or modified external resource reference is present. The changed install commands use the existing local package paths . and packages/kumo-api; the README adds no URL. Existing PyPI, GitHu…
Full details: Public Resource Access

Explanation

No added or modified external resource reference is present. The changed install commands use the existing local package paths . and packages/kumo-api; the README adds no URL. Existing PyPI, GitHub, S3, and package references occur only on removed or unchanged lines, which this check excludes.

Full details: Change Map Design Review

Explanation

The change map is incomplete and misleading about standalone distribution. The PR deletes both Kumo API PyPI workflows, but the retained kumo-sdk-release-on-tag.yml still publishes kumoai-studio. packages/kumo-sdk/setup.py constructs an exact kumo-api==<version> dependency, so future SDK releases still require a separately published API wheel. Engine bundling does not solve the SDK dependency. The nightly-specific prior concern is addressed because the nightly workflow was deleted.

Resolution

Retain an API publication path until all SDK release paths are replaced, or change the SDK release/package design so it does not require an independently published exact kumo-api version. If the retained SDK release path is obsolete, remove or disable it with the replacement kumo-studio-client pipeline. Add focused validation that installs a released SDK wheel from a clean PyPI-compatible index.

Finishing Touches
Fix failing CI checks
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

CodeRabbit Verify

  • Run CodeRabbit Verify to test the changes in this pull request.
ℹ️ Recent review info
⚙️ Run configuration
📥 Commits

Reviewing files that changed from the base of the PR and between 022e30d and 066772f.

📒 Files selected for processing: 2
  • .github/workflows/kumo-sdk-release-nightly.yml
  • packages/kumo-sdk/test/test_release_artifact.py
💤 Files with no reviewable changes: 2
  • .github/workflows/kumo-sdk-release-nightly.yml
  • packages/kumo-sdk/test/test_release_artifact.py

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 8 remain after this review.

@aaron-kumo
aaron-kumo had a problem deploying to gha-kumo-workflow-tests October 22, 2026 19:09 — with GitHub Actions Error
@aaron-kumo
aaron-kumo force-pushed the aaron/remove-kumo-api-release branch from cd6fcd5 to 022e30d Compare October 22, 2026 19:10
@aaron-kumo
aaron-kumo temporarily deployed to gha-kumo-workflow-tests October 22, 2026 19:10 — with GitHub Actions Inactive
@aaron-kumo
aaron-kumo requested a review from nivle1661 October 22, 2026 19:15
@aaron-kumo
aaron-kumo marked this pull request as ready for review October 22, 2026 19:15
nivle1661
nivle1661 previously approved these changes Oct 22, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration
📥 Commits

Reviewing files that changed from the base of the PR and between 3100e71 and 022e30d.

⛔ Files ignored due to path filters: 1
  • uv.lock is excluded by !**/*.lock, !**/*.lock
📒 Files selected for processing: 21
  • .github/workflows/kumo-api-hotfix-release.yml
  • .github/workflows/kumo-api-lint.yml
  • .github/workflows/kumo-api-release.yml
  • .github/workflows/kumo-api-testing.yml
  • packages/kumo-api/.github/actions/verify-import/action.yml
  • packages/kumo-api/README.md
  • packages/kumo-api/kumoapi/json_serde.py
  • packages/kumo-api/pyproject.toml
  • packages/kumo-api/test/test_release_plan.py
  • packages/kumo-api/tools/__init__.py
  • packages/kumo-api/tools/release_plan.py
  • packages/kumo-api/tools/schema_compat/__init__.py
  • packages/kumo-api/tools/schema_compat/__main__.py
  • packages/kumo-api/tools/schema_compat/cli.py
  • packages/kumo-api/tools/schema_compat/comparator.py
  • packages/kumo-api/tools/schema_compat/config.py
  • packages/kumo-api/tools/schema_compat/extractor.py
  • packages/kumo-api/tools/schema_compat/models.py
  • packages/kumo-api/tools/schema_compat/rules.py
  • packages/kumo-api/tools/schema_compat/storage.py
  • scripts/check_public_references.py
💤 Files with no reviewable changes: 17
  • packages/kumo-api/tools/init.py
  • .github/workflows/kumo-api-release.yml
  • packages/kumo-api/pyproject.toml
  • packages/kumo-api/tools/schema_compat/cli.py
  • packages/kumo-api/tools/schema_compat/main.py
  • scripts/check_public_references.py
  • .github/workflows/kumo-api-hotfix-release.yml
  • packages/kumo-api/test/test_release_plan.py
  • packages/kumo-api/tools/schema_compat/comparator.py
  • packages/kumo-api/tools/schema_compat/rules.py
  • packages/kumo-api/tools/schema_compat/init.py
  • .github/workflows/kumo-api-testing.yml
  • packages/kumo-api/tools/schema_compat/config.py
  • packages/kumo-api/tools/schema_compat/extractor.py
  • packages/kumo-api/tools/schema_compat/models.py
  • packages/kumo-api/tools/release_plan.py
  • packages/kumo-api/tools/schema_compat/storage.py

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 9 remain after this review.

Comment thread packages/kumo-api/README.md Resolved
@aaron-kumo
aaron-kumo temporarily deployed to gha-kumo-workflow-tests October 22, 2026 19:39 — with GitHub Actions Inactive
@aaron-kumo aaron-kumo changed the title Remove kumo-api's standalone release pipeline Remove standalone API releases and SDK nightly publishing Oct 22, 2026
@aaron-kumo
aaron-kumo requested a review from nivle1661 October 23, 2026 16:39
kumo-api is not distributed separately: kumo-engine bundles it, and so
will the kumo-studio-client release. Remove the kumo-api release and
hotfix workflows, which published it to PyPI and its schema to S3, along
with the release planner, the schema compatibility tool, their test,
and the release-check extra. Drop the inert schema-compat job from
kumo-api testing, which only read the version.
@aaron-kumo
aaron-kumo force-pushed the aaron/remove-kumo-api-release branch from 066772f to 5a883c7 Compare November 3, 2026 21:30
@aaron-kumo
aaron-kumo temporarily deployed to gha-kumo-workflow-tests November 3, 2026 21:30 — with GitHub Actions Inactive
@aaron-kumo
aaron-kumo requested a review from anle2024 November 3, 2026 21:34

This branch was previously deployed

1 inactive deployment
gha-kumo-workflow-tests — 5a883c71 Deployed Nov 3, 2026 by aaron-kumo via import #1406
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants