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 yamlfmt + yamllint #4077

Merged
merged 10 commits into from
Feb 12, 2025
Merged

Add yamlfmt + yamllint #4077

merged 10 commits into from
Feb 12, 2025

Conversation

bm1549
Copy link
Contributor

@bm1549 bm1549 commented Feb 12, 2025

Motivation

Address #1722

Changes

This adds yamlfmt and yamllint to add automatic formatting and linting to our yaml files

The reason we need both is because yamlfmt cannot check for key ordering while yamllint is only a linter so it cannot automatically re-format the files

After this is approved and merged, a follow-up should be done to update .yamllint to set key-ordering from disabled to enabled and the existing issues with key ordering should be resolved

Workflow

  1. ⚠️ Create your PR as draft ⚠️
  2. Work on you PR until the CI passes (if something not related to your task is failing, you can ignore it)
  3. Mark it as ready for review
    • Test logic is modified? -> Get a review from RFC owner. We're working on refining the codeowners file quickly.
    • Framework is modified, or non obvious usage of it -> get a review from R&P team

🚀 Once your PR is reviewed, you can merge it!

🛟 #apm-shared-testing 🛟

Reviewer checklist

  • If PR title starts with [<language>], double-check that only <language> is impacted by the change
  • No system-tests internal is modified. Otherwise, I have the approval from R&P team
  • CI is green, or failing jobs are not related to this change (and you are 100% sure about this statement)
  • A docker base image is modified?
    • the relevant build-XXX-image label is present
  • A scenario is added (or removed)?

@bm1549 bm1549 changed the title Add yamllint with permissive settings Add yamlfmt + yamllint Feb 12, 2025
@bm1549 bm1549 marked this pull request as ready for review February 12, 2025 18:01
@bm1549 bm1549 requested review from a team as code owners February 12, 2025 18:01
@bm1549 bm1549 requested review from sanchda, Yun-Kim and ValentinZakharov and removed request for a team February 12, 2025 18:01
@bm1549 bm1549 requested review from Mariovido, smola and zacharycmontoya and removed request for a team February 12, 2025 18:01
@bm1549 bm1549 merged commit b2d9f3f into main Feb 12, 2025
434 checks passed
@bm1549 bm1549 deleted the brian.marks/yaml-lint branch February 12, 2025 19:11
@bm1549 bm1549 mentioned this pull request Feb 12, 2025
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants