Conventional Changelog Evelyn

Conventional Changelog and Semantic Release presets for my projects

Description

Looking for a Semantic Release and Conventional Changelog configuration that allows for permissive types and scopes to generate nice changelog files with emoji?

Based off of the ESLint commit convention, I threw in extra types so you can load up your git client and type just about anything valid.

Example Commits

• Chore: Did a thing that is not user-facing
• New: Added a feature
• Update: Iterated on a feature
• Breaking: Changed the default behavior

Example Changelog

View CHANGELOG.md to see all of the emojis and sorting of commits in action!

Installation

# Install all of the things
npm install --save-dev @semantic-release/changelog @semantic-release/git commitlint husky semantic-release conventional-changelog-evelyn

Usage

Husky

To enforce the commit convention locally using Husky v6, add the following hook.

npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'

Package

To set up commitlint and semantic-release, add the following to your package.json file.

{
  "commitlint": {
    "extends": "./node_modules/conventional-changelog-evelyn/commitlint.config.js"
  },
  "release": {
    "extends": "conventional-changelog-evelyn/release.config.js"
  }
}

License

Copyright Evelyn Hathaway, MIT License