-
Notifications
You must be signed in to change notification settings - Fork 109
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 linting for yaml files #916
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
84f770e
to
146ec24
Compare
kate-osborn
approved these changes
Aug 1, 2023
sjberman
reviewed
Aug 1, 2023
pleshakov
reviewed
Aug 1, 2023
146ec24
to
fde277d
Compare
sjberman
approved these changes
Aug 2, 2023
pleshakov
approved these changes
Aug 2, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
fde277d
to
c327850
Compare
miledxz
added a commit
to miledxz/nginx-gateway-fabric
that referenced
this pull request
Jan 14, 2025
Add yamllint to pre-commit and CI
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Problem: The yaml files in the repo were not linted.
Solution: Add yamllint step to pre-commit and as a CI step. All yaml files except the helm template files will be linted before every commit (with some rules excepted for the .github workflow files, any yaml files that include raw NGINX config, and line length in the deployment yaml). Linting rules are in the
.yamllint.yaml
file in the root of the repo. For details on the linting rules, see: https://yamllint.readthedocs.io/en/stable/rules.html#Testing: Verified yaml files are linted on pre-commit.
Closes #539
Checklist
Before creating a PR, run through this checklist and mark each as complete.