ddazza / renogen Goto Github PK

Raise a warning if no YAML notes are found.

Check YAML files are valid syntax

When running
renogen new

Outcome
#=> Created './change_log/next/.yml'

Expectation
missing param error

Add ability to check all change notes and valid.

e.g.
$ renogen --check

error when backticks are used in YAML file

Stacktrace:

~/.rbenv/versions/2.3.0/lib/ruby/2.3.0/psych.rb:377:in `parse': (./change_log/next/test.yml): found character that cannot start any token while scanning for the next token at line 8 column 5 (Psych::SyntaxError)
        from ~/.rbenv/versions/2.3.0/lib/ruby/2.3.0/psych.rb:377:in `parse_stream'
        from ~/.rbenv/versions/2.3.0/lib/ruby/2.3.0/psych.rb:325:in `parse'
        from ~/.rbenv/versions/2.3.0/lib/ruby/2.3.0/psych.rb:252:in `load'
        from ~/.rbenv/versions/2.3.0/lib/ruby/2.3.0/psych.rb:471:in `block in load_file'
        from ~/.rbenv/versions/2.3.0/lib/ruby/2.3.0/psych.rb:471:in `open'
        from ~/.rbenv/versions/2.3.0/lib/ruby/2.3.0/psych.rb:471:in `load_file'

eg not have to specify multiple keys for single line comments

In the event that multiple notes include the same detail provide an option to remove duplicates.

e.g. bundle exec rake db:migrate may be required in mutiple notes however it will only need to appear in the final release notes once.

Be able to generate a new note file from a template by using a preset config listing common headings
e.g.Description, Author