zapier-platform icon indicating copy to clipboard operation
zapier-platform copied to clipboard

CHANGELOG.md incorrect format error is misleading

Open joshuathompson opened this issue 6 years ago • 9 comments

If you don't have a trailing newline at the end of your CHANGELOG.md file then the CLI will fail with:

Warning! Changelog not found. Please create a `CHANGELOG.md` file in a format similar to https://gist.github.com/xavdid/b9ede3565f1188ce339292acc29612b2, with user-facing descriptions

I'm okay with it wanting it in the exact format but the error message made it seem like the file was in the wrong directory / didn't exist.

UPDATE: This also is the case if you don't have an empty line between the version number and the bullet points.

What would you like to change?

Improve error messaging about validating the file structure or more forgiving validation.

Your Environment

  • zapier-platform-cli/7.0.0
  • zapier-platform-core/7.0.0
  • node/v8.10.0
  • OSX High Sierra 10.13.3

joshuathompson avatar Jun 22 '18 14:06 joshuathompson