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

Add test to assert that CHANGELOG.md gets updated #1517

Merged
merged 1 commit into from
Sep 16, 2024

Conversation

chrisseto
Copy link
Contributor

This commit adds a go test that asserts that CHANGELOG.md contains a head for each Chart.yaml version in the repository.

This will ensure that the CHANGELOG gets updated whenever a new chart versions are released.

@chrisseto
Copy link
Contributor Author

This might get annoying for just bumping appVersion, so I'm not dead set on seeing this merged. just pitching it as an option.

Copy link
Contributor

@RafalKorepta RafalKorepta left a comment

Choose a reason for hiding this comment

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

LGTM. I run it on my local and there is an issue 👍

=== RUN   TestChartYAMLVersions
    lint_test.go:38: 
        	Error Trace:	/Users/rafalkorepta/workspace/redpanda/helm-charts/pkg/lint/lint_test.go:38
        	Error:      	Should be true
        	Test:       	TestChartYAMLVersions
        	Messages:   	CHANGELOG.md is missing the release header for redpanda
        	            	Did you forget to add it?
        	            	### [5.9.2](https://github.com/redpanda-data/helm-charts/releases/tag/redpanda-5.9.2)

This might get annoying for just bumping appVersion, so I'm not dead set on seeing this merged. just pitching it as an option.

Personally I would invest in new automation for auto bumps which would include appVersion bump and filling the CHANGELOG.md

This commit adds a go test that asserts that CHANGELOG.md contains a head for
each Chart.yaml version in the repository.

This will ensure that the CHANGELOG gets updated whenever a new chart versions
are released.
@chrisseto chrisseto force-pushed the chris/p/changelog-lint branch from 5a5f974 to c00dfa8 Compare September 13, 2024 20:27
@chrisseto chrisseto merged commit 900b8c4 into main Sep 16, 2024
10 checks passed
@chrisseto chrisseto deleted the chris/p/changelog-lint branch September 16, 2024 14:37
@chrisseto
Copy link
Contributor Author

If anyone finds their way back to this PR because this test is giving them grief, I give them full rights revert this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants