cluster-api-provider-aws/.golangci-kal.yml at main · kubernetes-sigs/cluster-api-provider-aws · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
version: "2"

run:
  timeout: 10m
  go: "1.26"
  allow-parallel-runners: true

linters:
  default: none
  enable:
    - kubeapilinter # linter for Kube API conventions
  settings:
    custom:
      kubeapilinter:
        type: "module"
        description: KAL is the Kube-API-Linter and lints Kube like APIs based on API conventions and best practices.
        settings:
          linters:
            enable:
              #- "commentstart" # Ensure comments start with the serialized version of the field name.
              #- "conditions" # Ensure conditions have the correct json tags and markers.
              #- "integers" # Ensure only int32 and int64 are used for integers.
              #- "jsontags" # Ensure every field has a json tag.
              #- "maxlength" # Ensure all strings and arrays have maximum lengths/maximum items.
              #- "nobools" # Bools do not evolve over time, should use enums instead.
              #- "nofloats" # Ensure floats are not used.
              #- "optionalorrequired" # Every field should be marked as `+optional` or `+required`.
              # - "requiredfields" # Required fields should not be pointers, and should not have `omitempty`.
              - "statussubresource" # All root objects that have a `status` field should have a status subresource.

            # Linters below this line are disabled, pending conversation on how and when to enable them.
            disable:
              - "*" # We will manually enable new linters after understanding the impact. Disable all by default.
          lintersConfig:
            conditions:
              isFirstField: Warn # Require conditions to be the first field in the status struct.
              usePatchStrategy: Forbid # Conditions should not use the patch strategy on CRDs.
              useProtobuf: Forbid # We don't use protobuf, so protobuf tags are not required.
          # jsonTags:
          #   jsonTagRegex: "^[a-z][a-z0-9]*(?:[A-Z][a-z0-9]*)*$" # The default regex is appropriate for our use case.
          # optionalOrRequired:
          #   preferredOptionalMarker: optional | kubebuilder:validation:Optional # The preferred optional marker to use, fixes will suggest to use this marker. Defaults to `optional`.
          #   preferredRequiredMarker: required | kubebuilder:validation:Required # The preferred required marker to use, fixes will suggest to use this marker. Defaults to `required`.
          # requiredFields:
          #   pointerPolicy: Warn | SuggestFix # Defaults to `SuggestFix`. We want our required fields to not be pointers.

exclusions:
    generated: strict
    paths:
      - zz_generated.*\.go$
      - ".*_test.go"  # Exclude test files.
    rules:
    # KAL should only run on API folders.
    - path-except: "api//*"
      linters:
        - kubeapilinter
    - path: "api/v1beta1/*|api/v1alpha1/*"
      text: "Conditions field must be a slice of metav1.Condition"
      linters:
        - kubeapilinter
    - path: "api/v1beta1/*"
      text: "type ClusterIPFamily should not use an int, int8 or int16. Use int32 or int64 depending on bounding requirements"
      linters:
        - kubeapilinter
    - path: "exp/ipam/api/v1alpha1/*|exp/ipam/api/v1beta1/*"
      text: "field Prefix should not use an int, int8 or int16. Use int32 or int64 depending on bounding requirements"
      linters:
        - kubeapilinter
    # clusterctl and Runtime Hooks can be fixed once we bump their apiVersion.
    - path: "cmd/clusterctl/api/v1alpha3|exp/runtime/hooks/api/v1alpha1"
      text: "maxlength"
      linters:
        - kubeapilinter
    # controller-gen does not allow to add MaxItems to Schemaless fields
    - path: "api/v1beta1/*"
      text: "maxlength: field (AllOf|OneOf|AnyOf) must have a maximum items, add kubebuilder:validation:MaxItems marker"
      linters:
        - kubeapilinter
    # It does not make sense to add a maxItems marker on the *List structs as they are not used to generate CRD YAMLs.
    # This exclude will  be removed once https://github.com/JoelSpeed/kal/issues/38 is resolved.
    - path: "api/v1beta1/*|api/v1alpha1/*"
      text: "maxlength: field Items must have a maximum items, add kubebuilder:validation:MaxItems marker"
      linters:
        - kubeapilinter
    - path: "api/v1alpha1/*|api/v1beta1/*"
      text: "nobools"
      linters:
        - kubeapilinter
    # We follow the current CustomResourceDefinition field's json tag pattern.
    - path: "api/v1beta1/*"
      text: "field (XPreserveUnknownFields|XPreserveUnknownFields|XValidations|XMetadata|XIntOrString) json tag does not match pattern"
      linters:
        - kubeapilinter
    # The following rules are disabled until we migrate to the new API.
    - path: "bootstrap/kubeadm/api/v1beta1/kubeadm_types.go"
      text: "field Token is marked as required, should not be a pointer"
      linters:
        - kubeapilinter
    - path: "api/v1beta1/clusterclass_types.go"
      text: "field Ref is marked as required, should not be a pointer"
      linters:
        - kubeapilinter
    - path: "api/v1alpha1/*|api/v1beta1/*|api/v1alpha3/*"
      text: "field Items must be marked as optional or required"
      linters:
        - kubeapilinter

issues:
  max-same-issues: 0
  max-issues-per-linter: 0