Transform Lint Warnings into Errors #3756

Kalaiselvi84 · 2024-04-10T23:09:07Z

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 · 2024-04-11T01:51:52Z

Build Succeeded 👏

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

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

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 · 2024-04-11T20:22:41Z

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 · 2024-04-11T21:14:11Z

Build Failed 😱

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

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

agones-bot · 2024-04-15T20:40:42Z

Build Succeeded 👏

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

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

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 · 2024-04-15T21:48:13Z

Build Succeeded 👏

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

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

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 · 2024-04-15T22:14:11Z

examples/gameserverallocation.yaml

@@ -85,34 +85,34 @@ spec:
      mode: deathmatch
    annotations:
      map: garden22
-  # [Stage: Alpha]


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?

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

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.

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

…into fix-lint-warn

agones-bot · 2024-04-16T01:35:03Z

Build Succeeded 👏

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

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

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

This PR contains the following updates: | Package | Update | Change | |---|---|---| | [agones](https://agones.dev) ([source](https://github.com/googleforgames/agones)) | minor | `1.39.0` -> `1.40.0` | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>googleforgames/agones (agones)</summary> ### [`v1.40.0`](https://github.com/googleforgames/agones/blob/HEAD/CHANGELOG.md#v1400-2024-04-23) [Compare Source](https://github.com/googleforgames/agones/compare/v1.39.0...v1.40.0) [Full Changelog](https://github.com/googleforgames/agones/compare/v1.39.0...v1.40.0) **Breaking changes:** - Counters and Lists: Remove Bool Returns by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3738 **Implemented enhancements:** - Leader Election in Custom Controller by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3696 - Migrating from generate-groups.sh to kube_codegen.sh by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3722 - Move GKEAutopilotExtendedDurationPods to Alpha in 1.28+ by [@zmerlynn](https://github.com/zmerlynn) in [googleforgames/agones#3729 - Move DisableResyncOnSDKServer to Beta by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3732 - Counters & Lists landing page and doc improvements by [@markmandel](https://github.com/markmandel) in [googleforgames/agones#3649 - Graduate FleetAllocationOverflow to Stable by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3733 - Adds Counters and Lists to CSharp SDK by [@igooch](https://github.com/igooch) in [googleforgames/agones#3581 - Feat/counter and list defaulting order to ascending by [@lacroixthomas](https://github.com/lacroixthomas) in [googleforgames/agones#3734 - Add handling for StatusAddresses in GameServerStatus for the Unity SDK by [@charlesvien](https://github.com/charlesvien) in [googleforgames/agones#3739 - Feat(gameservers): Shared pod IPs with GameServer Addresses by [@lacroixthomas](https://github.com/lacroixthomas) in [googleforgames/agones#3764 - Be prescriptive about rotating regions when updating Kubernetes versions by [@zmerlynn](https://github.com/zmerlynn) in [googleforgames/agones#3716 - Fix ensure-e2e-infra-state-bucket by [@zmerlynn](https://github.com/zmerlynn) in [googleforgames/agones#3719 - Create Performance Cluster 1.28 by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3720 - Optimise GameServer Sub-Controller Queues by [@markmandel](https://github.com/markmandel) in [googleforgames/agones#3781 **Fixed bugs:** - Counters & Lists: Consolidate `priorities` sorting by [@markmandel](https://github.com/markmandel) in [googleforgames/agones#3690 - Fix(Counter & Lists): Add validation for `priorities` by [@lacroixthomas](https://github.com/lacroixthomas) in [googleforgames/agones#3714 - fix: [#3607](https://github.com/googleforgames/agones/issues/3607) Metrics data loss in K8S controller by [@alvin-7](https://github.com/alvin-7) in [googleforgames/agones#3692 - Deflake GameServerAllocationDuringMultipleAllocationClients by allowing errors by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3750 **Security fixes:** - Bump protobufjs from 7.2.4 to 7.2.6 in /sdks/nodejs by [@dependabot](https://github.com/dependabot) in [googleforgames/agones#3755 - Bump golang.org/x/net from 0.19.0 to 0.23.0 by [@zmerlynn](https://github.com/zmerlynn) in [googleforgames/agones#3793 **Other:** - Flaky: TestGameServerCreationAfterDeletingOneExtensionsPod by [@markmandel](https://github.com/markmandel) in [googleforgames/agones#3699 - Prep for release v1.40.0 by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3700 - Bumps cpp-simple Image and Refactoring Example Makefiles by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3695 - Upgrade Protobuf to 1.33.0 by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3711 - Modify Script for Makefile Version Updates in Examples Directory by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3712 - Adds simple genai server example documentation to the Agones site by [@igooch](https://github.com/igooch) in [googleforgames/agones#3713 - Update Supported Kubernetes to 1.27, 1.28, 1.29 by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3654 - fix: typo in docs by [@qhyun2](https://github.com/qhyun2) in [googleforgames/agones#3723 - Tweak: Setting up the Game Server by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3717 - Docs: gke.md - spelling by [@daniellee](https://github.com/daniellee) in [googleforgames/agones#3740 - Aesthetic rearrangement of cloudbuild.yaml by [@zmerlynn](https://github.com/zmerlynn) in [googleforgames/agones#3741 - Docs: Make hitting <enter> on connection explicit by [@markmandel](https://github.com/markmandel) in [googleforgames/agones#3743 - CI: Don't check Unreal Link by [@markmandel](https://github.com/markmandel) in [googleforgames/agones#3745 - New recommendation for multi-cluster allocation by [@markmandel](https://github.com/markmandel) in [googleforgames/agones#3744 - Custom Controller Example Page on Agones Website by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3725 - Add Nitrado logo by [@towolf](https://github.com/towolf) in [googleforgames/agones#3753 - Remove unnecessary args from e2e-test-cloudbuild by [@zmerlynn](https://github.com/zmerlynn) in [googleforgames/agones#3754 - Update Allocation from Fleet Documentation by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3761 - Transform Lint Warnings into Errors by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3756 - Update Canary Testing Documentation by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3760 - Supertuxkart Example on Agones Site by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3728 - Xonotic Example on Agones Site by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3742 - nit documentation fix in kind cluster section when building Agones by [@vicentefb](https://github.com/vicentefb) in [googleforgames/agones#3770 - Merged steps inside documentation about webhook certificate creation by [@vicentefb](https://github.com/vicentefb) in [googleforgames/agones#3768 - Example Images: Increment Tags by [@Kalaiselvi84](https://github.com/Kalaiselvi84) in [googleforgames/agones#3796 - Update simple game server example documentation by [@vicentefb](https://github.com/vicentefb) in [googleforgames/agones#3776 **New Contributors:** - [@lacroixthomas](https://github.com/lacroixthomas) made their first contribution in [googleforgames/agones#3714 - [@daniellee](https://github.com/daniellee) made their first contribution in [googleforgames/agones#3740 - [@charlesvien](https://github.com/charlesvien) made their first contribution in [googleforgames/agones#3739 - [@vicentefb](https://github.com/vicentefb) made their first contribution in [googleforgames/agones#3770 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

Fix: Lint warning

1a0a5cd

Kalaiselvi84 requested a review from zmerlynn April 10, 2024 23:09

github-actions bot added kind/cleanup Refactoring code, fixing up documentation, etc size/S labels Apr 10, 2024

Turn warnings into error

84e0a38

github-actions bot added the size/M label Apr 11, 2024

Kalaiselvi84 requested a review from markmandel April 11, 2024 20:16

Merge branch 'main' into fix-lint-warn

89fea61

Kalaiselvi84 changed the title ~~Fix: Lint warning~~ Transform Lint Warnings into Errors Apr 11, 2024

Merge branch 'main' into fix-lint-warn

1f6a8d1

Merge branch 'main' into fix-lint-warn

db74145

zmerlynn reviewed Apr 15, 2024

View reviewed changes

Kalaiselvi84 added 3 commits April 15, 2024 22:33

ignore examples/gameserverallocation.yaml file in yamllint config

439c36e

Merge branch 'fix-lint-warn' of https://github.com/Kalaiselvi84/agones …

422379e

…into fix-lint-warn

disable yamllint for the specific section

e129d03

zmerlynn approved these changes Apr 16, 2024

View reviewed changes

zmerlynn merged commit 45ea667 into googleforgames:main Apr 16, 2024
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Transform Lint Warnings into Errors #3756

Transform Lint Warnings into Errors #3756

Kalaiselvi84 commented Apr 10, 2024 •

edited

Loading

agones-bot commented Apr 11, 2024

Kalaiselvi84 commented Apr 11, 2024 •

edited

Loading

agones-bot commented Apr 11, 2024

agones-bot commented Apr 15, 2024

agones-bot commented Apr 15, 2024

zmerlynn Apr 15, 2024

Kalaiselvi84 Apr 15, 2024

zmerlynn Apr 15, 2024 •

edited

Loading

Kalaiselvi84 Apr 16, 2024 •

edited

Loading

zmerlynn Apr 16, 2024

agones-bot commented Apr 16, 2024

Transform Lint Warnings into Errors #3756

Transform Lint Warnings into Errors #3756

Conversation

Kalaiselvi84 commented Apr 10, 2024 • edited Loading

agones-bot commented Apr 11, 2024

Kalaiselvi84 commented Apr 11, 2024 • edited Loading

agones-bot commented Apr 11, 2024

agones-bot commented Apr 15, 2024

agones-bot commented Apr 15, 2024

zmerlynn Apr 15, 2024

Choose a reason for hiding this comment

Kalaiselvi84 Apr 15, 2024

Choose a reason for hiding this comment

zmerlynn Apr 15, 2024 • edited Loading

Choose a reason for hiding this comment

Kalaiselvi84 Apr 16, 2024 • edited Loading

Choose a reason for hiding this comment

zmerlynn Apr 16, 2024

Choose a reason for hiding this comment

agones-bot commented Apr 16, 2024

Kalaiselvi84 commented Apr 10, 2024 •

edited

Loading

Kalaiselvi84 commented Apr 11, 2024 •

edited

Loading

zmerlynn Apr 15, 2024 •

edited

Loading

Kalaiselvi84 Apr 16, 2024 •

edited

Loading