kubernetes-sigs/cluster-api

API Linting Tracking Issue

Open

#11,834 opened on Feb 12, 2025

View on GitHub
 (9 comments) (2 reactions) (2 assignees)Go (1,532 forks)auto 404
help wantedkind/api-changepriority/important-soontriage/accepted

Repository metrics

Stars
 (4,267 stars)
PR merge metrics
 (PR metrics pending)

Description

As part of #11733, we have configured KAL, that kube-api-linter to run against the APIs within this repository.

There are a number of linter rules that need to be reviewed and enabled 1 by 1.

This issue is to track the implementation of enabling each of these linters

TODO

Not doing

NoPhase

Per discussion in July 2024, we are keeping phase fields for now. See https://github.com/kubernetes-sigs/cluster-api/pull/10897#discussion_r1685929508 and https://github.com/kubernetes-sigs/cluster-api/pull/10897#discussion_r1685919394 for the context on why we are still keeping phases.

Contributor guide

Research direction
Examine the KAL linter rule (optionalorrequired) and its follow up for Items fields. Look at previous PRs like #11909 to understand the pattern. Then identify all Items fields in the API types that may need the annotation and apply it.
Tech stack
go
Domain
apitooling
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Needs investigation
Prerequisites
GoKubernetesAPI conventions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40