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

API Linting Tracker (Phase 2) #11967

Open
JoelSpeed opened this issue Mar 13, 2025 · 1 comment
Open

API Linting Tracker (Phase 2) #11967

JoelSpeed opened this issue Mar 13, 2025 · 1 comment
Labels
kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@JoelSpeed
Copy link
Contributor

As a follow up to #11834

This issue tracks upcoming linters from KAL and their current status, so that we can track the new rules as they are implemented and get them enabled within CAPI.

For more detailed information and tracking, follow JoelSpeed/kal#1

Rule Description Implemented Enabled
nomaps Maps of objects should not be allowed False False
enums Enums are correctly tagged and use PascalCase False False
numericbounds Numeric fields should have upper and lower bounds False False
optionalfields Optional fields should have omitempty and usually be pointers False False
defaults Default values should use the upstream default marker False False
markertypos Checks for common typos in markers False False
nodurations Durations should be avoided, instead use an integer with a unit in the name False False
references Fields should use Ref(s) instead of Reference(s) False False
timestamps Do not use Timestamp in field names, use only Time False False
nameformats Common name fields (name/namespace) should use CEL format library to validate format False False
arrayofstruct Arrays of structs must have at least one required field False False
duplicatemarkers Checks for duplicate markers (eg enum twice on field and type) False False
typeandobjectmeta Enforces consistent standards for typemeta and objectmeta fields False False
statusoptional Top level status fields should all be optional False False
ssatags All lists must be marked with a listType False False
@k8s-ci-robot k8s-ci-robot added needs-priority Indicates an issue lacks a `priority/foo` label and requires one. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Mar 13, 2025
@sbueringer sbueringer added priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API triage/accepted Indicates an issue or PR is ready to be actively worked on. labels Mar 13, 2025
@k8s-ci-robot k8s-ci-robot removed needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-priority Indicates an issue lacks a `priority/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Mar 13, 2025
@sbueringer
Copy link
Member

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

No branches or pull requests

3 participants