Transform Lint Warnings into Errors

[Kalaiselvi84]

What type of PR is this?

Uncomment only one /kind <> line, press enter to put that in a new line, and remove leading whitespace from that line:

/kind breaking
/kind bug

/kind cleanup

/kind documentation
/kind feature
/kind hotfix
/kind release

What this PR does / Why we need it:

Which issue(s) this PR fixes:

Closes #

Special notes for your reviewer:

• I’m fixing some warnings that the lint pointed out in this PR,
  For ./cloudbuild.yaml, added more spaces before some comments to follow the rules.
  For ./examples/gameserverallocation.yaml, adjusted the indentation of a comment.

• Converting lint warnings into error by including rules in the yaml lint config file.

[agones-bot]

Build Succeeded 👏

Build Id: 98b0e917-88b8-49ff-b484-a7356a5ab225

The following development artifacts have been built, and will exist for the next 30 days:

• image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.40.0-dev-1a0a5cd-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.40.0-dev-1a0a5cd-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.40.0-dev-1a0a5cd-linux-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.40.0-dev-1a0a5cd-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.40.0-dev-1a0a5cd-amd64
• Linux C++ SDK (build): agonessdk-1.40.0-dev-1a0a5cd-amd64-linux-arch_64.tar.gz
• SDK Server: agonessdk-server-1.40.0-dev-1a0a5cd-amd64.zip

A preview of the website (the last 30 builds are retained):

• https://1a0a5cd-dot-preview-dot-agones-images.appspot.com/

To install this version:

• git fetch https://github.com/googleforgames/agones.git pull/3756/head:pr_3756 && git checkout pr_3756
• helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.40.0-dev-1a0a5cd-amd64

[Kalaiselvi84]

I added rules explicitly to convert warnings into errors in the yamllint config file. Unfortunately, there isn't a built-in method to globally change all rules to error if I am correct. You can find a list of available rules here. If there are any other rules you'd like me to include from the list, please let me know...

[agones-bot]

Build Failed 😱

Build Id: 517bbcd8-34c9-4eb1-9e21-6b1a2878f68c

• Cloud Build view
• Cloud Build log download

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

[agones-bot]

Build Succeeded 👏

Build Id: 85cf897d-cd8b-49c7-901e-8bdb249e1d2a

The following development artifacts have been built, and will exist for the next 30 days:

• image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.40.0-dev-1f6a8d1-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.40.0-dev-1f6a8d1-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.40.0-dev-1f6a8d1-linux-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.40.0-dev-1f6a8d1-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.40.0-dev-1f6a8d1-amd64
• Linux C++ SDK (build): agonessdk-1.40.0-dev-1f6a8d1-amd64-linux-arch_64.tar.gz
• SDK Server: agonessdk-server-1.40.0-dev-1f6a8d1-amd64.zip

A preview of the website (the last 30 builds are retained):

• https://1f6a8d1-dot-preview-dot-agones-images.appspot.com/

To install this version:

• git fetch https://github.com/googleforgames/agones.git pull/3756/head:pr_3756 && git checkout pr_3756
• helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.40.0-dev-1f6a8d1-amd64

[agones-bot]

Build Succeeded 👏

Build Id: 8cbcb179-f437-4879-bc7d-91303af292f0

The following development artifacts have been built, and will exist for the next 30 days:

• image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.40.0-dev-db74145-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.40.0-dev-db74145-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.40.0-dev-db74145-linux-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.40.0-dev-db74145-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.40.0-dev-db74145-amd64
• Linux C++ SDK (build): agonessdk-1.40.0-dev-db74145-amd64-linux-arch_64.tar.gz
• SDK Server: agonessdk-server-1.40.0-dev-db74145-amd64.zip

A preview of the website (the last 30 builds are retained):

• https://db74145-dot-preview-dot-agones-images.appspot.com/

To install this version:

• git fetch https://github.com/googleforgames/agones.git pull/3756/head:pr_3756 && git checkout pr_3756
• helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.40.0-dev-db74145-amd64

[zmerlynn]

This one doesn't look right to me. It's indenting it under .metadata.annotations (visually) but I don't think that's where the structure is. Can you disable yammlint for this block?

[Kalaiselvi84]

I have rolled back the modifications in this file and added it to the yamllint configuration to be ignored.

[zmerlynn]

I think it's better for pointwise suppressions like this to use comments to suppress it: https://yamllint.readthedocs.io/en/stable/disable_with_comments.html

ETA: It keeps the "configuration" next to the object, so to speak.

[Kalaiselvi84]

The following options to disable yamllint are working fine, I chose the first one, please let me know what you think..

  # yamllint disable rule:comments-indentation rule:line-length
  # yamllint disable

[zmerlynn]

LGTM

[agones-bot]

Build Succeeded 👏

Build Id: 710f3780-2f1d-4aac-8846-039a20ffd7f8

The following development artifacts have been built, and will exist for the next 30 days:

• image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.40.0-dev-e129d03-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.40.0-dev-e129d03-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.40.0-dev-e129d03-linux-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.40.0-dev-e129d03-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.40.0-dev-e129d03-amd64
• Linux C++ SDK (build): agonessdk-1.40.0-dev-e129d03-amd64-linux-arch_64.tar.gz
• SDK Server: agonessdk-server-1.40.0-dev-e129d03-amd64.zip

A preview of the website (the last 30 builds are retained):

• https://e129d03-dot-preview-dot-agones-images.appspot.com/

To install this version:

• git fetch https://github.com/googleforgames/agones.git pull/3756/head:pr_3756 && git checkout pr_3756
• helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.40.0-dev-e129d03-amd64