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

[BUG] In README.md, we recommend to install the helm plugin from latest main, we should recommend a versioned release instead #6

Open
jessesimpson36 opened this issue Oct 30, 2024 · 0 comments
Labels
good first issue Good for newcomers kind/bug a bug

Comments

@jessesimpson36
Copy link
Owner

jessesimpson36 commented Oct 30, 2024

Describe the issue:

Suppose a scenario where we release a 1.0.0, and we introduce a backwards incompatible change on top of that. We have not yet released yet, so the version number would still be 0.0.5, yet a breaking change occurred. If a user runs the recommended

helm plugin install https://github.com/jessesimpson36/yamldifftool.git

then they will get a backwards incompatible change.

Instead, we should find a way to install a specific version of the yamldifftool as a helm plugin. This may require introducing git tags, or github releases.

Expected behavior:

Actual behavior:

How to reproduce:

Logs:

Environment:

  • OS:
  • OS Version:
  • Distribution:
  • Python version:
@jessesimpson36 jessesimpson36 added kind/bug a bug good first issue Good for newcomers labels Oct 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers kind/bug a bug
Projects
None yet
Development

No branches or pull requests

1 participant