semantic-release-tamia

Tâmia Semantic Release

Custom semantic-release workflow:

• Fully automated PATCH and MINOR releases.
• MAJOR releases require a changelog.
• Custom commit convention.
• Release draft generator.

Read more in my article Automate npm releases with semantic-release and human-written changelogs.

Installation

First install semantic-release.

Then:

npm install --save-dev semantic-release-tamia

Add to your package.json:

"release": {
  "analyzeCommits": "semantic-release-tamia/analyzeCommits",
  "generateNotes": "semantic-release-tamia/generateNotes",
  "verifyRelease": "semantic-release-tamia/verifyRelease"
}

Release process

To release a new version, you’ll need to create a commit with Changelog type. To simplify the creation of it use tamia-changelog.

To generate a changelog draft run tamia-changelog. It will create a file with all important commits for the release grouped by type (breaking changes, new features and bugfixes) and open it in your default editor.

Now you can rewrite your changelog to make it valuable for your users.

To commit the changelog, run tamia-changelog commit. It will make a commit without changes (git commit --allow-empty) with a Changelog tag and the changelog text in commit message’s body.