docs: Add guide for working with loft-sh/api types#3720
Open
pascalbreuninger wants to merge 3 commits into
Open
docs: Add guide for working with loft-sh/api types#3720pascalbreuninger wants to merge 3 commits into
pascalbreuninger wants to merge 3 commits into
Conversation
Document the process for making changes to github.com/loft-sh/api/v4 types (in loft-enterprise) and testing them locally in vCluster before merging. This addresses the chicken-and-egg dependency issue where schema changes require coordinated updates across repositories. https://claude.ai/code/session_01L1AZrxEXzRecXFpimzP8gD
nprokopic
requested changes
Mar 23, 2026
|
|
||
| ### 4. Test Your Changes | ||
|
|
||
| Deploy a vCluster with your schema changes and verify the new configuration options work as expected. |
Contributor
There was a problem hiding this comment.
This step needs more clarification.
I have changes in /path/to/loft-enterprise/staging/src/github.com/loft-sh/api/v4 that I have to test in the platform, so after completing steps 1-3 above, I want to create a virtual cluster from the platform, and here I want to use local vCluster changes (so it uses locally changed schema from step 3 above).
Address PR review feedback from @nprokopic requesting more detail on how to actually test local vCluster changes from the platform. Added steps for building a custom Docker image and deploying it with a local chart using --local-chart-dir. https://claude.ai/code/session_01L1AZrxEXzRecXFpimzP8gD
The previous version incorrectly suggested using --local-chart-dir for platform testing. This flag only works with the Helm driver. When testing schema changes through the platform driver, intermediate pre-releases are required because the platform fetches charts from published releases. Updated docs to clearly separate the two workflows and document the version coupling implications. https://claude.ai/code/session_01L1AZrxEXzRecXFpimzP8gD
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What issue type does this pull request address?
/kind documentation
What does this pull request do? Which issues does it resolve?
This PR adds comprehensive documentation to the CONTRIBUTING.md file explaining how to work with types from the
github.com/loft-sh/api/v4package when developing vCluster locally.The new section covers:
replacedirectives ingo.modfor local testingThis documentation helps contributors understand the dependency relationship between vCluster and loft-enterprise, and provides clear guidance on the correct process for making and testing changes to shared API types.
Please provide a short message that should be published in the vcluster release notes
N/A - Documentation only
What else do we need to know?
This is a documentation-only change that adds a new section to CONTRIBUTING.md. No code changes or testing required.
E2E Tests
No testing needed - documentation only.
https://claude.ai/code/session_01L1AZrxEXzRecXFpimzP8gD