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

[helm] add lint checks for renderExamples #6060

Merged
merged 2 commits into from
Nov 20, 2024

Conversation

pkoutsovasilis
Copy link
Contributor

@pkoutsovasilis pkoutsovasilis commented Nov 18, 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

@pkoutsovasilis pkoutsovasilis added bug Something isn't working Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team backport-8.x Automated backport to the 8.x branch with mergify backport-8.16 Automated backport with mergify labels Nov 18, 2024
@pkoutsovasilis pkoutsovasilis self-assigned this Nov 18, 2024
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 marked this pull request as ready for review November 18, 2024 16:36
@pkoutsovasilis pkoutsovasilis requested a review from a team as a code owner November 18, 2024 16:36
@elasticmachine
Copy link
Contributor

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

@cmacknz cmacknz requested a review from swiatekm November 18, 2024 22:01
Copy link
Contributor

@blakerouse blakerouse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

@pkoutsovasilis pkoutsovasilis merged commit 0097d21 into elastic:main Nov 20, 2024
14 checks passed
mergify bot pushed a commit that referenced this pull request Nov 20, 2024
* fix: add lint checks for renderExamples

* fix: helm linting errors

(cherry picked from commit 0097d21)
mergify bot pushed a commit that referenced this pull request Nov 20, 2024
* fix: add lint checks for renderExamples

* fix: helm linting errors

(cherry picked from commit 0097d21)
pkoutsovasilis added a commit that referenced this pull request Nov 20, 2024
* fix: add lint checks for renderExamples

* fix: helm linting errors

(cherry picked from commit 0097d21)

Co-authored-by: Panos Koutsovasilis <panos.koutsovasilis@elastic.co>
pkoutsovasilis added a commit that referenced this pull request Nov 20, 2024
* fix: add lint checks for renderExamples

* fix: helm linting errors

(cherry picked from commit 0097d21)

Co-authored-by: Panos Koutsovasilis <panos.koutsovasilis@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.x Automated backport to the 8.x branch with mergify backport-8.16 Automated backport with mergify bug Something isn't working skip-changelog 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.

[helm] Extend Lint Checks to Include All Examples for Full Validation
4 participants