@4th-motion/release

Bump a new version and update your changelog with a single command.

Say goodbye to handwritten changelogs - with this tool, a GitHub release is created and all changes since the last version are automatically recorded in the changelog file. You can have a look at how such a generated changelog file looks like.

Installation

Add this package as a devDependency to your project:

yarn add --dev @4th-motion/release

Usage

Once that is done, you can run the command:

yarn release

You will be asked which version you want to release. If you have entered a valid version, your changelog will be adjusted, a tag will be created and all changes will be pushed. When you use certain keywords for your commits (e.g. fix:, feat:, …) your commits will be sorted accordingly in the changelog.

Note: If you want to make sure your team adheres to specific commit rules, we recommend to use @4th-motion/git-hooks. There you can define your rules and make sure that only schematically correct commits are pushed.

Customize to your needs

This script takes the master branch as default. And the changelog file must be in the root folder of your project. If you want to change these settings, you can pass some flags to the script.

yarn release --branch release
yarn release --changelog docs/changelog.md

Further documents

• Changelog
• Contributing
• Pull request
• Code of conduct

License

Copyright © 2020 by 4th motion GmbH. Released under the MIT License.