Fix chart linting issues in our helm chart #445
Merged
Conversation
This file contains hidden or 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
viveksinghggits
added
the
skip-changelog
MCK 1.3.1 Release Notes |
nammn
approved these changes
Sep 11, 2025
fealebenpae
approved these changes
Sep 11, 2025
MaciejKaras
approved these changes
Sep 12, 2025
3 tasks
viveksinghggits
added a commit
that referenced
this pull request
Sep 23, 2025
…_repo`) (#450) # Summary Whenever we raised PR in to helm chart repo CI failed there because we had linting issues in our helm chart. A previous PR that [I raised](#445) fixed the linting problem. But we should have a linting mechanism in our CI that would consistently check if we have made any mistake in our charts. This PR does that. The `chart_schema.yaml` and `lintconf.yaml` are the default yaml files using which `ct` should be run. And `ct` is the tool that is used for linting in our helm charts repo. ## Proof of Work Passing `lint_repo` task here https://spruce.mongodb.com/version/68c43aae1d5d5d000770c624/tasks?sorts=STATUS%3AASC%3BBASE_STATUS%3ADESC and in this PR as well. ## Checklist - [x] Have you linked a jira ticket and/or is the ticket in the title? - [x] Have you checked whether your jira ticket required DOCSP changes? - [x] Have you added changelog file? - use `skip-changelog` label if not needed - refer to [Changelog files and Release Notes](https://github.com/mongodb/mongodb-kubernetes/blob/master/CONTRIBUTING.md#changelog-files-and-release-notes) section in CONTRIBUTING.md for more details
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Summary
Whenever we raise a PR to the https://github.com/mongodb/helm-charts/ repo to release the helm chart, as part of the CI linting of the chart is done.
And that linting fails because there are some issues in our chart. The issue is a space character at the end of this file here.
To get the PR in, in the
helm-chartsrepo we just fixed the problem in that repo and didn't make the changes here in the MCK repo. This PR makes the change in MCK repo and in the next PR I am going to add chart linting as part of the lint_repo task so that we will always lint of charts.When we just go ahead and remove the trailing space from the mentioned line, our pre-commit hook doesn't pass. And the reason is when pre-commit hooks tries to update the version is chart.yaml here, the library (
ruamel.yaml.YAML()) that is used to update the yaml automatically adds a trailing space in that line. So, in other words, even if we manually remove the trailing space, our CI complains that there are some files that are not added after running pre-commit, and when we run pre-commit, the extra trailing space is added automatically.To fix that problem we are slightly changing the way we were adding description to the chart.yaml, and now we are using the correct way of adding multi line values in a yaml file.
Proof of Work
Checklist
skip-changeloglabel if not needed