Insurgent Lab's conventional-changelog preset

conventional-changelog preset built from a list of conventional commit types (similar to conventional-commit-types). Also provides release rules configuration for @semantic-release/commit-analyzer.

Commit types originally from:

• Conventional Commits
• commitizen/conventional-commit-types

Install

Starting from v9, this package is a pure ESM module, which will only work with semantic-release@>=22. If you cannot upgrade, you can keep using v8.

npm install --save-dev @insurgent/conventional-changelog-preset

Configuration for @semantic-release/commit-analyzer

{
  "plugins": [
    [
      "@semantic-release/commit-analyzer",
      {
        "config": "@insurgent/conventional-changelog-preset",
        "releaseRules": "@insurgent/conventional-changelog-preset/release-rules"
      }
    ]
  ]
}

Configuration for @semantic-release/release-notes-generator

{
  "plugins": [
    [
      "@semantic-release/release-notes-generator",
      {
        "config": "@insurgent/conventional-changelog-preset"
      }
    ]
  ]
}

Use with conventional-changelog

npm install --save-dev conventional-changelog

import conventionalChangelog from 'conventional-changelog';

const config = require('@insurgent/conventional-changelog-preset');
conventionalChangelog({ config }).pipe(process.stdout);

Commit types

| Commit Type | Title | Description | Emoji | Release | Include in changelog | | :---------: | ------------------------ | ----------------------------------------------------------------------------------------------------------- | :---: | ------------------------------ | :------------------: | | feat | Features | A new feature | ✨ | minor | true | | fix | Bug Fixes | A bug Fix | 🐛 | patch | true | | docs | Documentation | Documentation only changes | 📚 | patch if scope is readme | true | | style | Styles | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) | 💎 | - | true | | refactor | Code Refactoring | A code change that neither fixes a bug nor adds a feature | 📦 | - | true | | perf | Performance Improvements | A code change that improves performance | 🚀 | patch | true | | test | Tests | Adding missing tests or correcting existing tests | 🚨 | - | true | | build | Builds | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) | 🛠 | patch | true | | ci | Continuous Integrations | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) | ⚙️ | - | true | | chore | Chores | Other changes that don't modify src or test files | ♻️ | - | true | | revert | Reverts | Reverts a previous commit | 🗑 | - | true |

Related

• cz-conventional-changelog
• conventional-changelog