Skip to content

Standardized behavior for kustomize edit #5563

Open
@koba1t

Description

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! 🎉

Metadata

Assignees

No one assigned

    Labels

    kind/featureCategorizes issue or PR as related to a new feature.lifecycle/frozenIndicates that an issue or PR should not be auto-closed due to staleness.needs-triageIndicates an issue or PR lacks a `triage/foo` label and requires one.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions