CI: Implement prettier lint #7416

ADITYATIWARI342005 · 2025-11-03T10:37:55Z

What type of PR is this?

chore: implement go-prettier for yaml files and remove yanllint

What this PR does / why we need it:
removes yamllint and implements go-pretter lint instead of it.

Which issue(s) this PR fixes:

Fixes #7147

Release Notes: Yes/No

Signed-off-by: ADITYATIWARI342005 <[email protected]>

codecov · 2025-11-03T10:47:18Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 72.37%. Comparing base (2ec695d) to head (42257c7).
⚠️ Report is 6 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #7416      +/-   ##
==========================================
- Coverage   72.38%   72.37%   -0.01%     
==========================================
  Files         231      231              
  Lines       34039    34043       +4     
==========================================
+ Hits        24639    24640       +1     
- Misses       7626     7630       +4     
+ Partials     1774     1773       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

… the make target to call prettier instead of go-prettier Signed-off-by: ADITYATIWARI342005 <[email protected]>

…WARI342005/envoyproxy_gateway into implement-prettier-lint

…check-format-yaml target that runs prettier in check mode on tracked YAML files, and update the CI workflow to use the check target Signed-off-by: ADITYATIWARI342005 <[email protected]>

…nstead of ), and modify the GitHub Actions workflow to install prettier with go install and ensure the Go bin path is added Signed-off-by: ADITYATIWARI342005 <[email protected]>

Signed-off-by: ADITYA TIWARI <[email protected]>

ADITYATIWARI342005 · 2025-11-03T18:57:19Z

Hi @zirain
I am done with the implementation, and it passes all the CI checks !
Please review it and suggest changes especially in the .prettierignore file.

Thank you.

tools/make/lint.mk

zirain · 2025-11-04T00:40:27Z

tools/github-actions/setup-deps/action.yaml

  steps:
    - shell: bash
      run: sudo apt-get install libbtrfs-dev -y
-    - uses: actions/setup-go@44694675825211faa026b3c33043df3e48a5fa00  # v5.0.1


why this changed? I recalled this's required somewhere? two blank spaces before comment.

I believe it is from the automated prettier-yaml formatting as I do not remember making this change.

.github/workflows/yaml-format.yml

@latest

…all the correct go-prettier binary using a valid tag by switching to @latest, ensuring the formatter is available during CI Signed-off-by: ADITYATIWARI342005 <[email protected]>

Signed-off-by: ADITYA TIWARI <[email protected]>

… existing composite action Signed-off-by: ADITYA TIWARI <[email protected]>

zirain · 2025-11-04T09:25:32Z

release-notes/v0.1.0.yaml

it's fine to set up a excudle rule for files under this folder.

Signed-off-by: ADITYA TIWARI <[email protected]>

ADITYATIWARI342005 · 2025-11-04T09:59:12Z

why this changed? I recalled this's required somewhere? two blank spaces before comment.

@zirain
It would be good if you would clarify on how should I fix this
a) add this file to .prettierignore
b) only restore the unintentional change

I am confused about the fix, please help me !

Thank you.

ADITYATIWARI342005 · 2025-11-04T17:55:02Z

Hi @zirain
All the CI checks were passing until I added release-notes to .prettierignore.
I believe the PR has no concerning issues left except for the unintentional line edit from prettierlint, since addition of a filetype to .prettierignore is not a breaking change.
Please review the Pull Request.

Thank you.

ADITYATIWARI342005 · 2025-11-06T05:16:20Z

Hi @zirain
the PR is ready for review, all CI checks have passed successfully

why this changed? I recalled this's required somewhere? two blank spaces before comment.

@zirain It would be good if you would clarify on how should I fix this a) add this file to .prettierignore b) only restore the unintentional change

I am confused about the fix, please help me !

Please help me with this.

.prettierignore

zirain · 2025-11-06T05:33:04Z

.prettierignore

+**/.examples/**
+**/test/**
+**/.test/**
+tools/linter/golangci-lint/.golangci.yml


since we ignore .github/workflow, it's fine to add tools/github_actions

zirain · 2025-11-06T05:33:53Z

@ADITYATIWARI342005 thanks for your patient, can you revert all the changes under release-notes folder.

Signed-off-by: ADITYA TIWARI <[email protected]>

zirain · 2025-11-06T06:40:03Z

.prettierignore

 **/.examples/**
 **/test/**
 **/.test/**
-tools/linter/golangci-lint/.golangci.yml


why remove the prev value?

Same as other to satisfy gen-check

tools/linter/yamllint/.yamllint

.prettierignore

ADITYATIWARI342005 · 2025-11-06T06:49:37Z

Hi @zirain this was the log on running the lint tool, it failed on these files

Failed on .examples/redis/redis.yaml
Failed on .examples/simple-extension-server/simple-extension-server.yaml
Failed on .examples/kubernetes/zone-aware-routing.yaml
Failed on .examples/kubernetes/tcp-routing.yaml
Failed on .examples/kubernetes/ext-auth-grpc-service.yaml
Failed on .examples/kubernetes/http-routing.yaml
Failed on .examples/kubernetes/grpc-routing.yaml
Failed on .examples/kubernetes/quickstart.yaml
Failed on .examples/kubernetes/mergepatch.yaml
Failed on .examples/kubernetes/ext-auth-http-service.yaml
Failed on .examples/kubernetes/gateway-namespace-mode.yaml
Failed on .examples/kubernetes/ext-proc-grpc-service.yaml
Failed on .examples/kubernetes/accesslog/json-accesslog.yaml
Failed on .examples/kubernetes/accesslog/als-accesslog.yaml
Failed on .examples/kubernetes/accesslog/multi-sinks.yaml
Failed on .examples/kubernetes/accesslog/otel-accesslog.yaml
Failed on .examples/kubernetes/accesslog/text-accesslog.yaml
Failed on .examples/kubernetes/metric/otel-sink.yaml
Failed on .examples/kubernetes/envoy-proxy-config.yaml
Failed on .examples/kubernetes/tracing/zipkin.yaml
Failed on .examples/kubernetes/tracing/default.yaml
Failed on .examples/kubernetes/udp-routing-example-backend.yaml
Failed on .examples/kubernetes/tls-termination.yaml
Failed on .examples/kubernetes/merged-gateways.yaml
Failed on .examples/kubernetes/tls-passthrough.yaml
Failed on .examples/kubernetes/application.yaml
Failed on .examples/static-file-server/manifests/tls.yaml
Failed on .test/benchmark/config/nighthawk-test-server-config.yaml
Failed on .test/benchmark/config/nighthawk-test-server.yaml
Failed on .test/benchmark/config/gatewayclass.yaml
Failed on .test/e2e/base/manifests.yaml
Failed on .test/e2e/upgrade/manifests.yaml
Failed on .test/config/gatewayclass.yaml
Failed on .toolslinter/golangci-lint.golangci.yml

What should I do for these?

Signed-off-by: ADITYATIWARI342005 <[email protected]>

zirain · 2025-11-07T01:45:28Z

.prettierignore

+.vscode/
+
+# exclude release-notes
+release-notes/*


can you revert all the changes under release-notes because we excluded them?

…liance Signed-off-by: ADITYA TIWARI <[email protected]>

Signed-off-by: ADITYA TIWARI <[email protected]>

ADITYATIWARI342005 added 2 commits November 3, 2025 13:29

ci: replace yamllint with go-prettier for YAML formatting

8500843

Signed-off-by: ADITYATIWARI342005 <[email protected]>

Merge branch 'envoyproxy:main' into implement-prettier-lint

8453c4c

ADITYATIWARI342005 requested a review from a team as a code owner November 3, 2025 10:37

ADITYATIWARI342005 added 6 commits November 3, 2025 16:19

update the tools entry to the correct v3 path and binary name, adjust…

48dc7ce

… the make target to call prettier instead of go-prettier Signed-off-by: ADITYATIWARI342005 <[email protected]>

Merge branch 'implement-prettier-lint' of https://github.com/ADITYATI…

0ab7e0c

…WARI342005/envoyproxy_gateway into implement-prettier-lint

Add a .prettierignore mirroring the old yamllint ignore paths, add a …

5c90487

…check-format-yaml target that runs prettier in check mode on tracked YAML files, and update the CI workflow to use the check target Signed-off-by: ADITYATIWARI342005 <[email protected]>

update the Makefile to call the installed prettier binary directly (i…

8f5ab5a

…nstead of ), and modify the GitHub Actions workflow to install prettier with go install and ensure the Go bin path is added Signed-off-by: ADITYATIWARI342005 <[email protected]>

Update go-prettier installation to use latest version

eaf42a6

Signed-off-by: ADITYA TIWARI <[email protected]>

Ignore test and workflow files in Prettier

89d34f9

Signed-off-by: ADITYA TIWARI <[email protected]>

ADITYATIWARI342005 force-pushed the implement-prettier-lint branch 3 times, most recently from 184f678 to af2a1ce Compare November 3, 2025 17:36

Format YAML files with go-prettier; robust .prettierignore for CI

8b9b1ad

Signed-off-by: ADITYA TIWARI <[email protected]>

ADITYATIWARI342005 force-pushed the implement-prettier-lint branch from af2a1ce to 8b9b1ad Compare November 3, 2025 17:40

ADITYATIWARI342005 added 2 commits November 3, 2025 23:16

Merge branch 'main' into implement-prettier-lint

21f03c8

Signed-off-by: ADITYA TIWARI <[email protected]>

format release-notes/current.yaml

376742c

Signed-off-by: ADITYA TIWARI <[email protected]>

zirain reviewed Nov 4, 2025

View reviewed changes

tools/make/lint.mk Show resolved Hide resolved

zirain reviewed Nov 4, 2025

View reviewed changes

tools/make/lint.mk Show resolved Hide resolved

zirain reviewed Nov 4, 2025

View reviewed changes

.github/workflows/yaml-format.yml Outdated Show resolved Hide resolved

ADITYATIWARI342005 added 3 commits November 4, 2025 13:34

fix: delete the not required workflow and update the workflow to inst…

5ec53ad

…all the correct go-prettier binary using a valid tag by switching to @latest, ensuring the formatter is available during CI Signed-off-by: ADITYATIWARI342005 <[email protected]>

Merge branch 'main' into implement-prettier-lint

10d21b1

Signed-off-by: ADITYA TIWARI <[email protected]>

fix/ add installation of the prettier binary and PATH export into the…

82ab02e

… existing composite action Signed-off-by: ADITYA TIWARI <[email protected]>

zirain reviewed Nov 4, 2025

View reviewed changes

ADITYATIWARI342005 added 2 commits November 4, 2025 09:27

style: format release-notes/current.yaml via prettier for CI

4ad9271

Signed-off-by: ADITYA TIWARI <[email protected]>

fix/add release notes to .prettierignore

fabcd14

Signed-off-by: ADITYA TIWARI <[email protected]>

Merge branch 'main' into implement-prettier-lint

a128bfb

Merge branch 'main' into implement-prettier-lint

e728ddf