From 8853c9e1bf72115ba850cfbbf5c3e978837ec6ae Mon Sep 17 00:00:00 2001 From: brian d foy Date: Sun, 29 Dec 2024 21:22:46 -0500 Subject: [PATCH] use prove to test YAML. It's just easier. --- CONTRIBUTING.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b969e7f..501f7f4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -148,19 +148,16 @@ distribution name should be, run it again with the distribution name: $ perl util/make_record CVE-2022-1234 Some-Package +With no arguments, `util/make_record` will prompt your for the info +it needs. + Add that record to `cpansa/CPANSA-Some-Package.yml`. If that file already exists, you'll probably have to strip the leading `---` line from the `util/make_record` output since you aren't starting the YAML structure. -Once you add the new record, verify that the YAML is valid. Test all -the files: - - $ make test_all - -While you are working, you may want to test just the new files because -there are so many: +To test the YAML files, run the the author tests: - $ make test_new + $ prove -Ilib xt The tests use `yamllint` if it is available. You can do this yourself to ensure it doesn't warn about anything. We accept the default settings