Custom scripts for semantic-release
JavaScript
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib Feat: Upgrade to semantic-release 11 Dec 27, 2017
test Feat: Fix change log detection Feb 3, 2018
.gitignore
.prettierrc Feat: Upgrade to semantic-release 11 Dec 27, 2017
.travis.yml
Convention.md
Readme.md Feat: Upgrade to semantic-release 11 Dec 27, 2017
analyzeCommits.js
generateNotes.js
package-lock.json
package.json Fix: Update deps Mar 22, 2018
verifyRelease.js

Readme.md

Tâmia Semantic Release

npm Build Status

Custom semantic-release workflow:

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

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 change log 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 change log to make it valuable for your users.

To commit change log run tamia-changelog commit. It will make a commit without changes (git commit --allow-empty) of type Changelog and change log in commit message body.