Mirror of forum.nim-lang.org

7652 :: CHANGELOG utility

• iffy1 (orginal) [2021-03-17T15:06:41+01:00] view original

  Hi all! I wanted to make a quick post about a tool I use to manage CHANGELOG files in my Nim projects. Main features are:

  • Changelog entries are recorded in separate files (via changer add) to avoid merge conflicts
  • Also, I don't have to decide if the next version will be a major, minor or patch release until it's time to release
  • It will choose the next version automatically based on if there are new features, breaking changes or just fixes (which you can override, of course)
  • It can do regex string replacements on each entry (e.g. change #33 to a GitHub issue link)
  • It will automatically keep the version in CHANGELOG.md and the .nimble file in sync

  When it's time to make a new version, changer bump will concat all the files to the top of my CHANGELOG file and bump the version.

  Link: https://github.com/iffy/changer

  Basic usage:

  
  nimble install changer
  
  # once per project
  changer init
  
  # add a changelog entry
  changer add
  
  # preview new changelog
  changer bump -n
  
  # move all pending changelog entries to the changelog and bump the version
  changer bump
  Run

  Here's a transcript of using it:

  
  $ changer init
  touch CHANGELOG.md
  mkdir changes
  wrote changes/README.md
  wrote changes/config.toml
  
  $ changer add
  Change type:
    [F]ix
    [N]ew feature
    [B]reaking change
    [O]ther (default)
    ?
  n
  Describe change (this will show up in the changelog):
  Added a CHANGELOG
  changes/new-Added-a-20210317-094901.md
  
  $ changer add
  Change type:
    [F]ix
    [N]ew feature
    [B]reaking change
    [O]ther (default)
    ?
  f
  Describe change (this will show up in the changelog):
  Fixed something that was broken
  changes/fix-Fixed-something-that-20210317-094912.md
  
  $ changer bump -n
  # v0.1.0 - 2021-03-17
  
  - **NEW:** Added a CHANGELOG
  - **FIX:** Fixed something that was broken
  
  
  updating CHANGELOG.md ...
  rm changes/fix-Fixed-something-that-20210317-094912.md
  rm changes/new-Added-a-20210317-094901.md
  ok -> v0.1.0
  DRY RUN - no files changed
  
  $ changer bump
  # v0.1.0 - 2021-03-17
  
  - **NEW:** Added a CHANGELOG
  - **FIX:** Fixed something that was broken
  
  
  updating CHANGELOG.md ...
  rm changes/fix-Fixed-something-that-20210317-094912.md
  rm changes/new-Added-a-20210317-094901.md
  ok -> v0.1.0
  Run

  Feel free to use it in your projects if it's helpful. I've really enjoyed not spending my time fixing merge conflicts in the changelog :)

---