Skip to content

Latest commit

 

History

History
51 lines (40 loc) · 1.68 KB

README.md

File metadata and controls

51 lines (40 loc) · 1.68 KB

Changelog

Licence

A command line utility to create changelogs. A variation of the changelog utility used in gitlab. Allows for the

Pre-requisites

Conventions

  • Changelog.md must reside in root folder and must have top level header # Changelog
  • Must run command in same folder as Changelog.md

Workflow

  1. Create a new feature on a branch
  2. Create a new changelog entry for feature
    • Creates a folder called unreleased in root folder
    • Multiple people can be on their own branches with their own entries
  3. Merge work into release branch when ready
  4. Preview the changelog changelog release vX.X.X --preview
  5. Update the changelog changelog release vX.X.X
    • Version string can follow your preferred format
    • Will create a file called changelog.yml with all changes in root folder
  6. Commit the changes
    • Unreleased folder will be deleted
    • Can optionally keep the yaml files
  7. Cake

Development

Once you are satisfied with the current version of the code run the following:

tusk test
tusk release --version=X.X.X
git add -u
git tag vX.X.X
git commit -m"Latest release"

This performs the following:

  • Merge all elements into changelog.yml
  • Add all elements to CHANGELOG.md
  • copy the latest version to tools folder
  • Add all the updated file (includes the version in source code and the tool itself)
  • Tag the latest commit
  • Submit changes