Yaml linter #3358

Kalaiselvi84 · 2023-08-31T19:18:32Z

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 #2443

Special notes for your reviewer:

agones-bot · 2023-08-31T19:33:36Z

Build Failed 😱

Build Id: 8f325a3d-3954-4249-a3d4-9d0be609aba7

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

agones-bot · 2023-08-31T21:40:06Z

Build Failed 😱

Build Id: 91ed288a-05ac-465d-a032-21a13260793e

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

agones-bot · 2023-08-31T22:02:34Z

Build Failed 😱

Build Id: 25f0d0fb-42d7-49c9-8fdc-264eb71aca8d

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

agones-bot · 2023-09-01T00:06:32Z

Build Succeeded 👏

Build Id: d6787463-0e7d-483e-8420-56e4df2e8483

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://ecc4229-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3358/head:pr_3358 && git checkout pr_3358
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.35.0-dev-ecc4229-amd64

agones-bot · 2023-09-01T18:17:02Z

Build Succeeded 👏

Build Id: 3e2fd4cb-ac55-43d6-a747-e605a9683352

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://ad7ba65-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3358/head:pr_3358 && git checkout pr_3358
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.35.0-dev-ad7ba65-amd64

Kalaiselvi84 · 2023-09-05T18:26:25Z

test/load/allocation/scenario-values.yaml

@@ -20,31 +20,31 @@ agones:
        memory: 4000Mi
    affinity:
      nodeAffinity:
-        preferredDuringSchedulingIgnoredDuringExecution: null
+        preferredDuringSchedulingIgnoredDuringExecution:


@zmerlynn,
yamlfix formatter does these changes. Is it necessary to explicitly set preferredDuringSchedulingIgnoredDuringExecution to null, or is it acceptable to just omit it?

I believe we explicitly need to null it here. cc @gongmax

Included null

Kalaiselvi84 · 2023-09-05T18:45:23Z

.yamllint

+  truthy: disable
+  line-length:
+    max: 1500
+  trailing-spaces: disable


This is to ignore the trailing-spaces error

Trailing spaces seems like something we should flag?

The yamllint configuration will cause it to ignore spaces at the end of lines. Can we have it?

Right, I'm saying: I think we should lint that there are no trailing spaces (unless it is prohibitive for some reason).

excluded it from this config file

agones-bot · 2023-09-05T19:43:51Z

Build Succeeded 👏

Build Id: b8602171-64da-4abe-80d4-21aa84a11982

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://9474ac3-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3358/head:pr_3358 && git checkout pr_3358
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.35.0-dev-9474ac3-amd64

zmerlynn · 2023-09-05T20:52:58Z

.yamllint

@@ -4,4 +4,3 @@ rules:
  truthy: disable


Do we have a lot of violations of truthy?

All of our GitHub Actions workflow scripts use the on keyword, and we cannot replace it with true. Therefore, I've disabled that specific check.

Because the GitHub Actions parser is looking for on and not true? Huh.

That's right..

agones-bot · 2023-09-05T21:43:22Z

Build Succeeded 👏

Build Id: 977cfce9-446c-4e82-8c0f-4274de489771

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://79e876a-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3358/head:pr_3358 && git checkout pr_3358
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.35.0-dev-79e876a-amd64

agones-bot · 2023-09-05T22:48:44Z

Build Succeeded 👏

Build Id: 37f546e3-cd5b-4b4b-b37a-2258fb03b526

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://d04ebde-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3358/head:pr_3358 && git checkout pr_3358
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.35.0-dev-d04ebde-amd64

zmerlynn · 2023-09-05T23:44:02Z

build/Makefile

@@ -489,7 +489,7 @@ build-extensions-binary-linux-arm64: $(ensure-build-image)
 lint: LINT_TIMEOUT ?= 15m
 lint: $(ensure-build-image)
 	docker run -t -e "TERM=xterm-256color" -e "$(gomod_on)" --rm $(common_mounts) -w $(workdir_path) $(DOCKER_RUN_ARGS) $(build_tag) bash -c \
-		"golangci-lint run ./examples/... && golangci-lint run --timeout $(LINT_TIMEOUT) ./..."
+		"golangci-lint run ./examples/... && golangci-lint run --timeout $(LINT_TIMEOUT) ./... && find ../ -name '*.yml' -o -name '*.yaml' | grep -v './install/' | xargs yamllint"


two things here:

Are you sure about ..? I think you're at the top of the repo here

I think we should prefer exclusions using the yamllint config itself rather than find. You can just use yamllint . and then ignore paths in a .gitignore style way. That allows people to just run yamllint outside docker or the Makefile and keep the config the same. I think it would just look roughly like:

ignore: - /install/

I wouldn't bother configuring the yaml suffixes, it looks like the default is appropriate.

agones-bot · 2023-09-06T03:21:47Z

Build Succeeded 👏

Build Id: 201fab39-a059-439b-bbb6-a3257dbfc09d

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://d772da1-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3358/head:pr_3358 && git checkout pr_3358
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.35.0-dev-d772da1-amd64

google-oss-prow · 2023-09-06T17:28:44Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: gongmax, igooch, Kalaiselvi84, zmerlynn
Once this PR has been reviewed and has the lgtm label, please assign cyriltovena for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

agones-bot · 2023-09-06T18:14:52Z

Build Failed 😱

Build Id: a9b92c2f-0a48-479f-9c7e-b150ec0a59bc

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

agones-bot · 2023-09-06T19:34:14Z

Build Failed 😱

Build Id: 42f9e58d-87c7-4efd-abe0-952379ddf685

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

agones-bot · 2023-09-06T21:58:40Z

Build Succeeded 👏

Build Id: 0566f347-4469-4c49-af87-9d0bd2ca6eaf

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://88034f2-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3358/head:pr_3358 && git checkout pr_3358
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.35.0-dev-88034f2-amd64

Yaml linter

5e51b67

Kalaiselvi84 requested review from markmandel and igooch August 31, 2023 19:18

google-oss-prow bot requested review from EricFortin and steven-supersolid August 31, 2023 19:18

google-oss-prow bot added the size/XXL label Aug 31, 2023

github-actions bot added the kind/cleanup Refactoring code, fixing up documentation, etc label Aug 31, 2023

Kalaiselvi84 marked this pull request as draft August 31, 2023 20:20

google-oss-prow bot added the do-not-merge/work-in-progress label Aug 31, 2023

excluded some directories

8d89171

removed for loop approach

0a50ac9

Kalaiselvi84 added 2 commits August 31, 2023 22:08

small tweak

a15ad91

included node_modules dir

ecc4229

Kalaiselvi84 added 3 commits September 1, 2023 16:59

reverted changes from site/themes/docsy/assets/vendor

6e05356

reverted changes from test/terraform/vendor

bc56c8c

reverted changes from vendor

ad7ba65

Kalaiselvi84 marked this pull request as ready for review September 1, 2023 18:20

google-oss-prow bot removed the do-not-merge/work-in-progress label Sep 1, 2023

google-oss-prow bot requested a review from cyriltovena September 1, 2023 18:20

Kalaiselvi84 removed request for cyriltovena and EricFortin September 1, 2023 18:20

igooch approved these changes Sep 5, 2023

View reviewed changes

google-oss-prow bot assigned igooch Sep 5, 2023

google-oss-prow bot added the lgtm label Sep 5, 2023

gongmax approved these changes Sep 5, 2023

View reviewed changes

google-oss-prow bot assigned gongmax Sep 5, 2023

Kalaiselvi84 commented Sep 5, 2023

View reviewed changes

Kalaiselvi84 added 2 commits September 5, 2023 18:33

arrays in multiline

fd67e2c

update yamllint config to ignore trailing-spaces

9474ac3

google-oss-prow bot removed the lgtm label Sep 5, 2023

Kalaiselvi84 commented Sep 5, 2023

View reviewed changes

Enabled trailing-spaces check

79e876a

zmerlynn reviewed Sep 5, 2023

View reviewed changes

Merge branch 'main' into linter-yaml

d04ebde

zmerlynn reviewed Sep 5, 2023

View reviewed changes

Ignore directories in config file

d772da1

undo files from fd67e2c

88034f2

zmerlynn approved these changes Sep 6, 2023

View reviewed changes

google-oss-prow bot assigned zmerlynn Sep 6, 2023

google-oss-prow bot added the lgtm label Sep 6, 2023

zmerlynn enabled auto-merge (squash) September 6, 2023 17:29

zmerlynn merged commit 130beb1 into googleforgames:main Sep 6, 2023
2 checks passed

Bogay mentioned this pull request Oct 4, 2023

Add a YAML linter to increase consistency #2443

Closed

igooch mentioned this pull request Jan 18, 2024

Request for igooch to become Approver #3600

Closed

5 tasks

Kalaiselvi84 deleted the linter-yaml branch March 15, 2024 01:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Yaml linter #3358

Yaml linter #3358

Kalaiselvi84 commented Aug 31, 2023 •

edited

Loading

agones-bot commented Aug 31, 2023

agones-bot commented Aug 31, 2023

agones-bot commented Aug 31, 2023

agones-bot commented Sep 1, 2023

agones-bot commented Sep 1, 2023

Kalaiselvi84 Sep 5, 2023 •

edited

Loading

zmerlynn Sep 5, 2023

Kalaiselvi84 Sep 5, 2023

Kalaiselvi84 Sep 5, 2023

zmerlynn Sep 5, 2023

Kalaiselvi84 Sep 5, 2023

zmerlynn Sep 5, 2023

Kalaiselvi84 Sep 5, 2023

agones-bot commented Sep 5, 2023

zmerlynn Sep 5, 2023 •

edited

Loading

Kalaiselvi84 Sep 5, 2023

zmerlynn Sep 5, 2023

Kalaiselvi84 Sep 5, 2023

agones-bot commented Sep 5, 2023

agones-bot commented Sep 5, 2023

zmerlynn Sep 5, 2023

agones-bot commented Sep 6, 2023

google-oss-prow bot commented Sep 6, 2023

agones-bot commented Sep 6, 2023

agones-bot commented Sep 6, 2023

agones-bot commented Sep 6, 2023

Yaml linter #3358

Yaml linter #3358

Conversation

Kalaiselvi84 commented Aug 31, 2023 • edited Loading

agones-bot commented Aug 31, 2023

agones-bot commented Aug 31, 2023

agones-bot commented Aug 31, 2023

agones-bot commented Sep 1, 2023

agones-bot commented Sep 1, 2023

Kalaiselvi84 Sep 5, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agones-bot commented Sep 5, 2023

zmerlynn Sep 5, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agones-bot commented Sep 5, 2023

agones-bot commented Sep 5, 2023

Choose a reason for hiding this comment

agones-bot commented Sep 6, 2023

google-oss-prow bot commented Sep 6, 2023

agones-bot commented Sep 6, 2023

agones-bot commented Sep 6, 2023

agones-bot commented Sep 6, 2023

Kalaiselvi84 commented Aug 31, 2023 •

edited

Loading

Kalaiselvi84 Sep 5, 2023 •

edited

Loading

zmerlynn Sep 5, 2023 •

edited

Loading