search

juju / charm-tools

Tools for charm authors and maintainers
Other
42 stars 64 forks source link

`charm proof` always complains about README.ex #501

Open pmatulis opened 5 years ago

pmatulis commented 5 years ago

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.

johnsca commented 5 years ago

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).

timClicks commented 5 years ago

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