charm-tools icon indicating copy to clipboard operation
charm-tools copied to clipboard

`charm proof` always complains about README.ex

Open pmatulis opened this issue 6 years ago • 2 comments

Invoking charm proof yields the below output, even if the README.ex template (from charm create) has been edited:

W: Includes template README.ex file
W: README.ex includes boilerplate: Step by step instructions on using the charm:
W: README.ex includes boilerplate: You can then browse to http://ip-address to configure the service.
W: README.ex includes boilerplate: - Upstream mailing list or contact information
W: README.ex includes boilerplate: - Feel free to add things if it's useful for users

This should only be shown if README.ex is the same as the template (use hash?).

Running 2.5.2.

pmatulis avatar Mar 01 '19 10:03 pmatulis

The problem is that it still has the .ex extension. It should be changed in the template to either .example or, better yet, just .md (in which case we would need to do a content check in proof as you suggest, rather than a simple filename check).

johnsca avatar Mar 01 '19 13:03 johnsca

Changing the charm template to README.md makes sense to me.

(in which case we would need to do a content check in proof as you suggest, rather than a simple filename check)

Am not sure that I follow here. charm proof does check the file's contents already. Thus the boilerplate messages in @pmatulis's output

timClicks avatar May 21 '19 02:05 timClicks