Skip to content

Commit

Permalink
use prove to test YAML. It's just easier.
Browse files Browse the repository at this point in the history
  • Loading branch information
briandfoy committed Dec 30, 2024
1 parent 308a393 commit 8853c9e
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 8853c9e

Please sign in to comment.