Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Compose a Changelog

Compose a Changelog

Automate your CHANGELOG as part of a release cycle.
Tracking software revisions, done right.

Steve Mao

May 18, 2016

Other Decks in Technology


  1. Compose a Changelog Automate your CHANGELOG as part of a

    release cycle. Tracking software revisions, done right.
  2. https://github.com/stevemao https://twitter.com/MaoStevemao

  3. Hm? A new release? Why the heck should I upgrade?

  4. Node.js v6 is RELEASED!!!!

  5. What were the changes?

  6. "semver to the rescue!" (http://semver.org)

  7. BUT, what exactly are the CHANGES? 1.0.0 -> 1.0.1 1.0.0

    -> 2.0.0 1.0.0 -> 1.1.0 Upgrade will make potential bugs in my app automagically disappear Upgrade will add additional features to my app. Still upgrade, but be extra careful (provide instructions as to how to upgrade). I was hoping…
  8. https://github.com/nodejs/nodejs.org/pull/263 Just bump all your deps! CI is not complaining

    (SFFOLFFQFSJTTNJMJOH More features plz!! Automagically bug fixes
  9. The reality is… Probably not

  10. Changelog is necessary Disagree? Let’s remove all the necessary docs

    then :) Remove README Remove CONTRIBUTING Remove LICENSE CHANGELOG is just as important as these docs
  11. Let’s dig into git history!

  12. git diff-so-fancy?

  13. So Fancy~

  14. None
  15. What? Not friendly to non-tech people Not so straight forward

  16. What about git-changelog?

  17. Write everything manually?

  18. None
  19. conventional-changelog Generate a changelog from git metadata

  20. Automate docs generation?

  21. The “Angular” notation

  22. SERIOUSLY? Why?

  23. Transform it

  24. Templates

  25. GitHub releases?

  26. What inspires us? conventional-recommended-bump - Get a recommended version bump

    based on conventional commits conventional-commits-detector - Detect what commit message convention your repository is using commitizen - Simple commit conventions for internet citizens. angular-precommit - Pre commit with angular conventions conventional-changelog-lint - Lint commit messages against your conventional-changelog preset Standard Version - stop using npm version, use standard- version it rocks!
  27. Tool integrations gulp Grunt atom (editor) And more (to be

  28. Who’s using the tool? Angular JSHint npm You!!

  29. Questions?