buildo/smooth-release

can't preview Changelog before it is pushed

Opened this issue · 2 comments

smooth-release should pause between UPDATE CHANGELOG and COMMIT AND PUSH CHANGES, so you can inspect the ChangeLog that was generated locally, before it is pushed to GitHub.

After the first time the changelog usually changes just a little and only with additions.
If you like it, we could consider showing a nice diff of the changelog (we could simply run git diff).

This should be enough in most cases and, as it's blocking anyway (you have of course to confirm the diff) you may inspect the changelog fully through a new terminal window.

I'm still not sure if this should be the default behavior though... do everyone really care about it? I personally never did :)

A diff would be good. I'd like it to be the default behaviour for a few reasons:

  • if there is a bug in smooth-release you can stop before a wrong Changelog is committed (like in #68)
  • you might have forgotten a "breaking" label, or notice something should be listed under "fixes" instead of "new features". If you see the diff, you can exit, modify some labels, and try again
  • I think having all prompts enabled is safer for new users, and disabling a prompt should be an "expert" feature you explicitly enabled in the config file or with a command-line flag