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 NOTES.txt check #430

Merged
merged 3 commits into from
Apr 23, 2024
Merged

Add NOTES.txt check #430

merged 3 commits into from
Apr 23, 2024

Conversation

trgeiger
Copy link
Contributor

@trgeiger trgeiger commented Apr 1, 2024

Checks for NOTES.txt in the chart's templates directory. Includes tests.

Closes #428

Right now it's just another mandatory check since we don't have any logic for optional checks. I'm not sure how everyone feels about optional vs. mandatory.

Signed-off-by: Tayler Geiger <[email protected]>
@komish
Copy link
Contributor

komish commented Apr 19, 2024

@trgeiger thanks for this - just two things

  • NOTES.txt is intended to convey information to the end-user, but some charts may not have information to convey. If we're going to add this check, it probably needs to be optional across all profiles.
  • Any references to "Notes" should specify "NOTES.txt", so that our expectations are clear.

Also change command help message to say "NOTES.txt"
Also add breaks to has-notes and has-readme logic
Copy link
Contributor

@komish komish left a comment

Choose a reason for hiding this comment

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

/lgtm

@komish komish merged commit 05eb514 into redhat-certification:main Apr 23, 2024
6 checks passed
@komish
Copy link
Contributor

komish commented Apr 23, 2024

Thanks @trgeiger

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.

Add check for the existence of NOTES.txt template in a given chart
2 participants