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

Add test for API deprecation/removal #4576

Closed
AlekSi opened this issue Nov 22, 2021 · 0 comments · Fixed by #4612
Closed

Add test for API deprecation/removal #4576

AlekSi opened this issue Nov 22, 2021 · 0 comments · Fixed by #4612
Milestone

Comments

@AlekSi
Copy link
Contributor

AlekSi commented Nov 22, 2021

Talos is not 1.0 yet, so technically, we can break our APIs in incompatible ways anytime. In practice, we are not doing that because that would make everyone's life harder. Still, we want to clean up our APIs before the 1.0 release: use common field names and conventions, rework APIs that are hard to use correctly, etc.

The existing prototool break check is a part of the solution, but not all of it.

I propose to modify an existing apid_test (and maybe find a better place for it) to check deprecated options and comments in .proto files and fail if a deprecated entity is not removed on time.

For example:

message ListRequest {
  // Use recursion_depth instead.
  // This field will be removed in v0.16.
  bool recurse = 2 [deprecated = true];
  int32 recursion_depth = 3;

The test will fail if the current version is 0.16.

@AlekSi AlekSi self-assigned this Nov 22, 2021
@AlekSi AlekSi added this to the v0.14 milestone Nov 22, 2021
AlekSi added a commit to AlekSi/talos that referenced this issue Nov 23, 2021
Refs siderolabs#4576.

Signed-off-by: Alexey Palazhchenko <alexey.palazhchenko@talos-systems.com>
AlekSi added a commit to AlekSi/talos that referenced this issue Nov 23, 2021
Refs siderolabs#4576.

Signed-off-by: Alexey Palazhchenko <alexey.palazhchenko@talos-systems.com>
AlekSi added a commit to AlekSi/talos that referenced this issue Nov 29, 2021
Refs siderolabs#4576.

Signed-off-by: Alexey Palazhchenko <alexey.palazhchenko@talos-systems.com>
AlekSi added a commit to AlekSi/talos that referenced this issue Nov 29, 2021
Refs siderolabs#4576.

Signed-off-by: Alexey Palazhchenko <alexey.palazhchenko@talos-systems.com>
AlekSi added a commit to AlekSi/talos that referenced this issue Nov 29, 2021
Refs siderolabs#4576.

Signed-off-by: Alexey Palazhchenko <alexey.palazhchenko@talos-systems.com>
AlekSi added a commit to AlekSi/talos that referenced this issue Nov 29, 2021
Refs siderolabs#4576.

Signed-off-by: Alexey Palazhchenko <alexey.palazhchenko@talos-systems.com>
AlekSi added a commit to AlekSi/talos that referenced this issue Nov 29, 2021
Closes siderolabs#4576.

Signed-off-by: Alexey Palazhchenko <alexey.palazhchenko@talos-systems.com>
AlekSi added a commit to AlekSi/talos that referenced this issue Nov 30, 2021
Closes siderolabs#4576.

Signed-off-by: Alexey Palazhchenko <alexey.palazhchenko@talos-systems.com>
AlekSi added a commit to AlekSi/talos that referenced this issue Nov 30, 2021
Refs siderolabs#4576.

Signed-off-by: Alexey Palazhchenko <alexey.palazhchenko@talos-systems.com>
AlekSi added a commit to AlekSi/talos that referenced this issue Nov 30, 2021
Closes siderolabs#4576.

Signed-off-by: Alexey Palazhchenko <alexey.palazhchenko@talos-systems.com>
AlekSi added a commit to AlekSi/talos that referenced this issue Nov 30, 2021
Closes siderolabs#4576.

Signed-off-by: Alexey Palazhchenko <alexey.palazhchenko@talos-systems.com>
@AlekSi AlekSi removed their assignment Nov 30, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant