Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create sub-directories in config for versions #2181

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

rmweir
Copy link
Contributor

@rmweir rmweir commented Sep 25, 2024

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?

Copy link

netlify bot commented Sep 25, 2024

Deploy Preview for vcluster-docs canceled.

Built without sensitive environment variables

Name Link
🔨 Latest commit 9485d98
🔍 Latest deploy log https://app.netlify.com/sites/vcluster-docs/deploys/66f9660b64ee1200083d9390

@rmweir rmweir requested a review from FabianKramm September 25, 2024 23:34
@rmweir rmweir force-pushed the version-subdirs branch 2 times, most recently from 91c7ea2 to bf35278 Compare September 28, 2024 18:23
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.
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.

1 participant