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

introduce snapshot testing for the chart #138

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jlandowner
Copy link
Contributor

@jlandowner jlandowner commented Feb 9, 2025

Summary of changes:

Hi, thank you for the useful and stable chart.
I would like to introduce snapshot testing for the chart project.
It allows to you to detect any change of the chart for common usecases.
You can check the impact on common usecases on Git before release.

Here is the examples.

Confirm not to break any existing feature.

スクリーンショット 2025-02-09 17 53 08

Detect a broken change.

スクリーンショット 2025-02-09 17 40 57

Update the snapshots by a single command

スクリーンショット 2025-02-09 17 45 06

This way is adopted in Kong chart project. https://github.com/Kong/charts/tree/main/charts/kong/ci
It is also good to do snapshot testing in CI but it's not in this PR so far (but Kong does!)

ref:
https://github.com/Kong/charts/blob/main/.github/workflows/release-pr.yaml#L208
https://github.com/Kong/charts/blob/main/Makefile#L70

Please feel free to try it!

Checklist:

  • I updated the artifacthub.io/changes annotation in Chart.yml according to the documentation
  • Optional: I updated in README.md the Helm Values

@jdetroyes jdetroyes self-assigned this Feb 11, 2025
@jdetroyes jdetroyes added the enhancement New feature or request label Feb 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants