Skip to content

Instantly share code, notes, and snippets.

@Batou99

Batou99/CHANGELOG_AND_TAGGING.md

Created April 20, 2017 13:30
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save Batou99/fa8be497337e5e866e0c36fdf48ddcb6 to your computer and use it in GitHub Desktop.
Save Batou99/fa8be497337e5e866e0c36fdf48ddcb6 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
CHANGELOG_AND_TAGGING.md

Steps to update the CHANGELOG

  1. When branching out, edit the CHANGELOG.md and add an "Unreleased" section on top
  2. The section will have subsections (in needed) for
    • Added
    • Changed
    • Deprecated
    • Removed
    • Fixed
    • Security
  3. Add the appropriate entries on the corresponding subsection
  4. When merging to master we will end up with one Unreleased section with one or many subentries
  5. Before deploying
  6. Choose an appropriate tag using v#{version}.#{minor_version}.#{patch}
  7. Rename the Unreleased section with the version number and date
  8. Commit the change
  9. Tag the commit
  10. Deploy

NOTE: See Keepaachangelog for more information

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment