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

Standardized behavior for kustomize edit #5563

Open
1 of 2 tasks
koba1t opened this issue Mar 6, 2024 · 1 comment
Open
1 of 2 tasks

Standardized behavior for kustomize edit #5563

koba1t opened this issue Mar 6, 2024 · 1 comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.

Comments

@koba1t
Copy link
Member

koba1t commented Mar 6, 2024

Eschewed features

  • This issue is not requesting templating, unstuctured edits, build-time side-effects from args or env vars, or any other eschewed feature.

What would you like to have added?

Make documentation of what is a common standardized behavior in all subcommands in the kustomize edit region to improve unified UX.

Why is this needed?

Currently, the behavior of the kustomize edit subcommand is not standardized and documented and is sometimes confused when implemented to add a function for new literal support.
I think we can decide to implement the same behavior at some points.
For example,

  • If the user uses any file path, that file does not exist.
  • If the user adds the same one that already exists.
  • If the user adds any literals that are already marked deprecated.

Can you accomplish the motivating task without this feature, and if so, how?

If we don't have this document, someone who wants to add support for the edit subcommand needs to check the already existing code for implementation, and the reviewer needs to check the behavior in that PR carefully.

What other solutions have you considered?

I think none.

Anything else we should know?

So, we need to care about current implements in the edit subcommand behavior and keep the current behavior if we can.

Feature ownership

  • I am interested in contributing this feature myself! 🎉
@koba1t koba1t added the kind/feature Categorizes issue or PR as related to a new feature. label Mar 6, 2024
@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Mar 6, 2024
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

SIG CLI takes a lead on issue triage for this repo, but any Kubernetes member can accept issues by applying the triage/accepted label.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.
Projects
None yet
Development

No branches or pull requests

2 participants