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 .yamllint config file to use yamllint to enhance linting for yaml files #1521

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions .yamllint
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
extends: default

ignore:
- config # Skip autogenerated config dir from liniting

rules:
# Rules to control the number of spaces around operators
braces:
min-spaces-inside: 0 # No spaces required inside braces
max-spaces-inside: 1 # Maximum one space inside braces
brackets:
min-spaces-inside: 0
max-spaces-inside: 1
colons:
max-spaces-before: 0
max-spaces-after: 1
commas:
max-spaces-before: 0
max-spaces-after: 1
hyphens:
max-spaces-after: 1

# Rules to control indentation
indentation:
spaces: consistent # Spaces should be consistently used for indentation
indent-sequences: whatever # Either indenting or not indenting individual block sequences is OK
comments-indentation: enable # Comments should be indented the same as the content

# Rules to control lines
line-length:
max: 150 # Maximum 150 characters per line
allow-non-breakable-words: true # Allow long words without breaks
allow-non-breakable-inline-mappings: true # Allow long inline mappings without breaks
empty-lines:
max: 2 # Maximum two consecutive empty lines allowed
trailing-spaces: enable # Ensure no trailing spaces at the end of lines

# Other rules
comments:
min-spaces-from-content: 1 # At least one space required between content and comment
key-duplicates: enable # Ensure no duplicate keys in mappings
truthy:
allowed-values: ['true', 'false', 'on', 'off'] # Allow only these values for boolean scalars
5 changes: 5 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,11 @@ vet:
help: # Display this help
@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n\nTargets:\n"} /^[0-9A-Za-z_-]+:.*?##/ { printf " \033[36m%-45s\033[0m %s\n", $$1, $$2 } /^\$$\([0-9A-Za-z_-]+\):.*?##/ { gsub("_","-", $$1); printf " \033[36m%-45s\033[0m %s\n", tolower(substr($$1, 3, length($$1)-7)), $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)

# Install yamllint if not present
Copy link
Contributor

@Prajyot-Parab Prajyot-Parab Jan 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Move this target under lint/verify section
  2. This will just install the lint (you can refer normal lint target in Makefile to see how the tooling is installed and follow same approach)
  3. You need to introduce a target to run the yamlint against the project (present one just installs it)

.PHONY: install-yamllint
install-yamllint:
@which yamllint > /dev/null || (echo "Installing yamllint..." && pip install yamllint)

## --------------------------------------
## Generate / Manifests
## --------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ releaseSeries:
contract: v1beta1
- major: 0
minor: 7
contract: v1beta1
contract: v1beta1
4 changes: 2 additions & 2 deletions templates/bases/vpc/kcp.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,14 @@ spec:
initConfiguration:
nodeRegistration:
criSocket: /var/run/containerd/containerd.sock
kubeletExtraArgs:
kubeletExtraArgs:
cloud-provider: external
eviction-hard: 'nodefs.available<0%,nodefs.inodesFree<0%,imagefs.available<0%'
joinConfiguration:
discovery: {}
nodeRegistration:
criSocket: /var/run/containerd/containerd.sock
kubeletExtraArgs:
kubeletExtraArgs:
cloud-provider: external
eviction-hard: 'nodefs.available<0%,nodefs.inodesFree<0%,imagefs.available<0%'
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,12 @@ spec:
ref:
apiVersion: bootstrap.cluster.x-k8s.io/v1beta1
kind: KubeadmConfigTemplate
name: "${IBMPOWERVS_CLUSTER_CLASS_NAME}-md-0"
name: "${IBMPOWERVS_CLUSTER_CLASS_NAME}-md-0"
infrastructure:
ref:
apiVersion: infrastructure.cluster.x-k8s.io/v1beta2
kind: IBMPowerVSMachineTemplate
name: "${IBMPOWERVS_CLUSTER_CLASS_NAME}-worker-machinetemplate"
name: "${IBMPOWERVS_CLUSTER_CLASS_NAME}-worker-machinetemplate"
---
apiVersion: infrastructure.cluster.x-k8s.io/v1beta2
kind: IBMPowerVSClusterTemplate
Expand Down
1 change: 0 additions & 1 deletion templates/cluster-template-powervs/kcp.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,3 @@ spec:
nodeRegistration:
kubeletExtraArgs:
provider-id: ibmpowervs://${CLUSTER_NAME}/'{{ v1.local_hostname }}'

Original file line number Diff line number Diff line change
Expand Up @@ -104,13 +104,13 @@ spec:
initConfiguration:
nodeRegistration:
criSocket: /var/run/containerd/containerd.sock
kubeletExtraArgs:
kubeletExtraArgs:
cloud-provider: external
eviction-hard: 'nodefs.available<0%,nodefs.inodesFree<0%,imagefs.available<0%'
joinConfiguration:
discovery: {}
nodeRegistration:
criSocket: /var/run/containerd/containerd.sock
kubeletExtraArgs:
kubeletExtraArgs:
cloud-provider: external
eviction-hard: 'nodefs.available<0%,nodefs.inodesFree<0%,imagefs.available<0%'
1 change: 0 additions & 1 deletion templates/cluster-template/cluster.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ metadata:
namespace: "${NAMESPACE}"
labels:
ccm: external

1 change: 0 additions & 1 deletion templates/cluster-template/kcp.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,3 @@ spec:
apiServer:
extraArgs:
cloud-provider: external

2 changes: 1 addition & 1 deletion test/e2e/data/cni/calico/calico.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4229,7 +4229,7 @@ rules:
resources:
- endpointslices
verbs:
- watch
- watch
- list
- apiGroups: [""]
resources:
Expand Down