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

Enable yamllint for Helm Chart and GitHub Actions #2018

Merged
merged 4 commits into from
May 23, 2024

Conversation

lucacome
Copy link
Member

@lucacome lucacome commented May 23, 2024

Proposed changes

Problem: We're not linting YAML files in the Helm Chart and GitHub Actions directories

Solution: Enable yamllint for these directories and fix the problems.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Release notes

If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.

NONE

Problem: We're not linting YAML files for in the Helm Chart and GitHub
Actions directories

Solution: Enable yamllint for these directories and fix the problems.
@lucacome lucacome requested a review from a team as a code owner May 23, 2024 00:17
@github-actions github-actions bot added chore Pull requests for routine tasks helm-chart Relates to helm chart labels May 23, 2024
@lucacome lucacome self-assigned this May 23, 2024
.github/workflows/ci.yml Show resolved Hide resolved
.github/workflows/lint.yml Outdated Show resolved Hide resolved
charts/nginx-gateway-fabric/values.yaml Show resolved Hide resolved
@sjberman
Copy link
Contributor

Does helm lint do anything different from yamllint? Do we want to add that as well? (maybe separate PR)

@lucacome
Copy link
Member Author

lucacome commented May 23, 2024

Does helm lint do anything different from yamllint? Do we want to add that as well? (maybe separate PR)

We already have helm lint in the lint workflow, but it doesn't lint the values.yaml. I'm working on adding some things to that workflow soon, that's how I stumbled into this and decided to open a separate PR 🙂

@lucacome lucacome merged commit b2cc0da into nginxinc:main May 23, 2024
40 checks passed
@lucacome lucacome deleted the chore/yamllint branch May 23, 2024 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Pull requests for routine tasks helm-chart Relates to helm chart
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants