Skip to content
This repository has been archived by the owner on Feb 22, 2022. It is now read-only.

Adding a CI check for the NOTES.txt file #2453

Merged
merged 1 commit into from
Oct 13, 2017

Conversation

mattfarina
Copy link
Contributor

Points to docs when file missing to point user to a fix

Ref #2373

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 10, 2017
Points to docs when file missing to point user to a fix

Ref helm#2373
@prydonius
Copy link
Member

We may also want to move this check to the helm lint command given that it's a best practice @mattfarina. Thoughts?

@prydonius prydonius self-assigned this Oct 13, 2017
@mattfarina
Copy link
Contributor Author

@prydonius is it a best practice? I don't see it in the best practices guide. Is it a best practice for everyone or a requirement of this repo?

I think we should merge this in here. If this is a best practice we can make a change to helm. Once helm lint has that change we can remove the custom check here.

Is NOTES.txt as a best practice a good talk for the charts and helm calls?

@prydonius
Copy link
Member

@mattfarina agree that it should be discussed in one of the calls, I personally feel it is a best practice, but there are also cases when NOTES.txt is not necessary (e.g. very small tools, internal things that have documentation elsewhere). Will merge this for now.

@prydonius
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Oct 13, 2017
@prydonius prydonius merged commit 8ca39ff into helm:master Oct 13, 2017
@mattfarina mattfarina deleted the lint-notes.txt branch October 13, 2017 20:59
dnelson pushed a commit to Vungle/charts that referenced this pull request Oct 26, 2017
Points to docs when file missing to point user to a fix

Ref helm#2373
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm Indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants