Skip to content

BLDX-1048: Move app-contract-toolkit into SDK monorepo#1500

Open
Aryamanz29 wants to merge 2 commits intomainfrom
aryaman/bldx-1048
Open

BLDX-1048: Move app-contract-toolkit into SDK monorepo#1500
Aryamanz29 wants to merge 2 commits intomainfrom
aryaman/bldx-1048

Conversation

@Aryamanz29
Copy link
Copy Markdown
Member

Summary

  • Move Pkl contract toolkit sources into contract-toolkit/ directory
  • Add separate CI workflows for toolkit validation and release
  • Independent versioning via toolkit/v* tag prefix (SDK continues using v*)

Changes

contract-toolkit/ (new directory)

  • Full Pkl sources: NativeApp.pkl, Config.pkl, Connectors.pkl, Credential.pkl, Renderers.pkl
  • 7 examples (redshift, trino, monte-carlo, cosmos, mode, sap-s4, teradata)
  • Tests and validation scripts
  • PklProject updated: package://atlanhq.github.io/application-sdk/app-contract-toolkit@0.5.0

.github/workflows/toolkit-validate.yaml (new)

  • Triggered on PRs changing contract-toolkit/**
  • Jobs: regenerate examples, check invariants, lint Python, SDK import test, docs reminder

.github/workflows/toolkit-release.yaml (new)

  • Triggered on push to main when contract-toolkit/src/ changes (+ workflow_dispatch)
  • Auto version bump via conventional commits
  • Build Pkl package, publish to gh-pages, create GitHub Release with toolkit/v* tag

Release Strategy

  • SDK releases: v3.0.0, v3.0.1 (existing)
  • Toolkit releases: toolkit/v0.5.0, toolkit/v0.6.0 (new, independent)
  • Both coexist in the same repo with separate CI pipelines

Migration Path

  1. This PR adds toolkit to SDK repo
  2. Companion CLI PR updates atlan app contract commands to point to new location
  3. atlan app contract update-toolkit auto-migrates consumer apps from old URI
  4. Old app-contract-toolkit repo archived (gh-pages stays live for existing versions)

Companion PR

  • CLI: atlanhq/atlan-cli (branch aryaman/bldx-1048)

Linear

https://linear.app/atlan-epd/issue/BLDX-1048

- Copy Pkl sources, examples, tests, scripts into contract-toolkit/
- Update PklProject URI to atlanhq.github.io/application-sdk/app-contract-toolkit
- Bump toolkit version to 0.5.0
- Add toolkit-validate.yaml (PR checks for contract-toolkit/ changes)
- Add toolkit-release.yaml (auto-publish with toolkit/v* tag prefix)
- Separate release stream: SDK uses v* tags, toolkit uses toolkit/v* tags
@snykgituser
Copy link
Copy Markdown

snykgituser commented Apr 21, 2026

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@Aryamanz29 Aryamanz29 self-assigned this Apr 21, 2026
@Aryamanz29
Copy link
Copy Markdown
Member Author

v3 relevance check: ✅ Active — contract toolkit monorepo migration (BLDX-1048). Needs review.

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