Create sub-directories in config for versions #2181
Draft
Conversation
This file contains 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
✅ Deploy Preview for vcluster-docs canceled.Built without sensitive environment variables
|
rmweir
force-pushed
the
version-subdirs
branch
2 times, most recently
from
91c7ea2
to
bf35278
Compare
Some vcluster config logic is version specific. Splitting the config package into version specific sub-directories helps maintain backwards compatibility for package consumers. The subdirectories allow us to use version specific code as needed without carrying it forward to newer versions, creating unnecessary technical debt. Separate go module versions were proposed as an alternative but were rejected in favor of sub-directories for now, as sub-directories are simpler to implement and does not necessitate consumers to import multiple modules.
rmweir
force-pushed
the
version-subdirs
branch
from
bf35278
to
562da84
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Some vcluster config logic is version specific. Splitting the config package into version specific sub-directories helps maintain backwards compatibility for package consumers. The subdirectories allow us to use version specific code as needed without carrying it forward to newer versions, creating unnecessary technical debt. Separate go module versions were proposed as an alternative but were rejected in favor of sub-directories for now, as sub-directories are simpler to implement and does not necessitate consumers to import multiple modules.
What issue type does this pull request address? (keep at least one, remove the others)
/kind enhancement
What does this pull request do? Which issues does it resolve? (use
resolves #<issue_number>if possible)resolves #
Please provide a short message that should be published in the vcluster release notes
What else do we need to know?