Skip to content

Add local testing instructions - #54

Open
strickvl wants to merge 4 commits into
developfrom
add-local-testing-instructions
Open

Add local testing instructions#54
strickvl wants to merge 4 commits into
developfrom
add-local-testing-instructions

Conversation

@strickvl

@strickvl strickvl commented Mar 19, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Updates TESTING.md with two testing paths:
    • Option A: Dev server — install ZenML from PyPI (zenml[server]>=0.94.1), start server, run pnpm dev with hot reload
    • Option B: Docker — build UI, copy dist/ to kitaru repo, build server-dev-image, test production-like serving
  • Updates AGENTS.md testing section with a compact summary of both paths
  • Default install path now uses PyPI instead of git branch clone (ZenML 0.94.1 is released)
  • Keeps install-kitaru-branch.sh as a fallback for testing against unreleased ZenML branches

Test plan

  • Verify Option A instructions work: uv pip install "zenml[server]>=0.94.1"zenml login --localpnpm dev → open localhost:5173
  • Verify Option B instructions work: pnpm build → copy dist/just server-dev-image → open localhost:8080
  • Confirm AGENTS.md renders correctly with the updated Testing section

Add TESTING.md with step-by-step guide for testing the UI against a
local ZenML server, and add a Testing section to AGENTS.md pointing
to it.
@vercel

vercel Bot commented Mar 19, 2026

Copy link
Copy Markdown

@strickvl must be a member of the ZenML GmbH team on Vercel to deploy.
- Click here to add @strickvl to the team.
- If you initiated this build, request access.

Learn more about collaboration on Vercel and other options here.

@strickvl

Copy link
Copy Markdown
Contributor Author

I'll need to update this to use kitaru stuff. WIll update

@strickvl
strickvl marked this pull request as draft March 19, 2026 11:32
@Cahllagerfeld
Cahllagerfeld marked this pull request as ready for review March 19, 2026 16:27
@Cahllagerfeld

Copy link
Copy Markdown
Collaborator

The content right now looks good to me already 👍

@strickvl

Copy link
Copy Markdown
Contributor Author

The content right now looks good to me already 👍

Yeah but it's for zenml now... I need to update it after we figure out how we're packaging the kitaru-ui UI inside the kitaru pypi package etc...

- Default install path now uses PyPI (zenml[server]>=0.94.1) instead
  of git branch clone
- Add Option B: Docker-based testing using kitaru server-dev image
- Keep install-kitaru-branch.sh as fallback for unreleased ZenML
- Update AGENTS.md testing section to summarize both paths
@vercel

vercel Bot commented Mar 20, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
kitaru-ui Error Error Mar 20, 2026 10:32am

Request Review

@strickvl
strickvl requested a review from Cahllagerfeld March 20, 2026 10:30
@strickvl strickvl added the documentation Improvements or additions to documentation label Mar 20, 2026
Testing should install from the kitaru repo (uv sync --extra local)
rather than installing ZenML directly. Kitaru pulls in ZenML as a
dependency, and kitaru login --local starts the same server.
kitaru login defaults to local server, no --local flag needed.
@Cahllagerfeld
Cahllagerfeld changed the base branch from main to develop May 12, 2026 07:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants