Skip to content

Conversation

@ABaldwinHunter
Copy link
Contributor

Culled from http://www.foodcritic.io/#FC064

@codeclimate/review @mrb

@ABaldwinHunter
Copy link
Contributor Author

{ "type":"issue", "check_name":"FoodCritic/FC064", "description":"Ensure issues_url is set in metadata", "categories":["Style"], "location": { "path":"cookbooks/foo/metadata.rb", "lines":{"begin":1,"end":1}}, "content":{ "body": "This warning is shown if a cookbook does not include the issues_url\nproperty in its metadata file. issues_url is used to point to the location\nfor submitting issues (bugs) for the  cookbook and is currently parsed by\nSupermarket to add links to community cookbooks. Note:  issues_url is a Chef\n12 only feature that will cause cookbook failures in Chef 11 so it should\nbe  properly gated if the code will be run on Chef 11 hosts.\n" }, "remediation_points":50000,"fingerprint":"e4e87ba31f76f8d0256bc2a9f7e67315", "engine_name":"foodcritic" }
@ABaldwinHunter
Copy link
Contributor Author

screen shot 2016-06-24 at 3 53 58 pm

@ABaldwinHunter
Copy link
Contributor Author

I’m curious about whether missing content in these issues could be causing them to be dropped by builder. Might be unrelated, but adding content here seems like a win either way!

doc/rules.yml Outdated
This warning is shown if a cookbook does not include the issues\_url
property in its metadata file. issues\_url is used to point to the location
for submitting issues (bugs) for the cookbook and is currently parsed by
Supermarket to add links to community cookbooks. Note: issues_url is a Chef

Choose a reason for hiding this comment

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

Missing \ in issues_url here?

@wfleming
Copy link

Content looks fine to me modulo my nits.

I would not expect these to cause builder to drop anything. I would like to know what this engine does when the appropriate key isn't in this yml.

@ABaldwinHunter
Copy link
Contributor Author

@wfleming I think the summary defaults to an empty string https://github.com/codeclimate-community/codeclimate-foodcritic/blob/master/lib/cc/engine.rb#L80

I'd like to consider exposing the FC-nn codes as well in the description, but in a separate PR perhaps.

@ABaldwinHunter ABaldwinHunter merged commit 6821a1f into master Jun 24, 2016
@ABaldwinHunter ABaldwinHunter deleted the abh-content branch June 24, 2016 21:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

3 participants