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

[8.16](backport #6060) [helm] add lint checks for renderExamples #6091

Merged
merged 1 commit into from
Nov 20, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Nov 20, 2024

What does this PR do?

This PR extends the Helm lint checks in our CI pipeline to validate all examples in the Helm chart. Previously, the helm template command passed successfully but was insufficient because helm lint could still fail. By ensuring comprehensive linting, we address inconsistencies and prevent errors during deployment.

Key changes include:

  • Adding additional lint checks to cover example configurations in the Helm chart.

Why is it important?

This change is important to ensure consistency across our Helm chart configurations. By extending the lint checks to include all examples, we can catch issues ( such as the ones seen in this Buildkite job) early in the CI pipeline, reducing the risk of deployment failures.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in ./changelog/fragments using the changelog tool
  • I have added an integration test or an E2E test

Disruptive User Impact

This change does not introduce any disruptive impact on users. The enhancements are internal to the CI validation process and do not affect end-user experience directly.

How to test this PR locally

  1. Run helm template ./deploy/helm/elastic-agent -f ./deploy/helm/elastic-agent/examples/kubernetes-default/agent-kubernetes-values.yaml to ensure it passes.
  2. Run helm lint ./deploy/helm/elastic-agent -f ./deploy/helm/elastic-agent/examples/kubernetes-default/agent-kubernetes-values.yaml and confirm that the lint checks also pass without errors.

mage helm:renderExamples does lint validation for all examples as well

Related issues

* fix: add lint checks for renderExamples

* fix: helm linting errors

(cherry picked from commit 0097d21)
@mergify mergify bot requested a review from a team as a code owner November 20, 2024 10:08
@mergify mergify bot added the backport label Nov 20, 2024
@mergify mergify bot requested review from michalpristas and blakerouse and removed request for a team November 20, 2024 10:08
@pierrehilbert pierrehilbert added the Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team label Nov 20, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/elastic-agent-control-plane (Team:Elastic-Agent-Control-Plane)

Copy link

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

@pkoutsovasilis pkoutsovasilis merged commit ce93cd9 into 8.16 Nov 20, 2024
16 checks passed
@pkoutsovasilis pkoutsovasilis deleted the mergify/bp/8.16/pr-6060 branch November 20, 2024 12:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants