Label schema definition for lerna-changelog
Emojis | Category | Label Display | Preset: default | Preset: full | Description |
---|---|---|---|---|---|
⭐ | Feature | Type: Feature |
✅ | ✅ | Includes new features |
🐛 | Bug | Type: Bug |
✅ | ✅ | Bug or Bug fixes |
🔒 | Security | Type: Security |
✅ | ✅ | Security fixes |
📈 | Performance | Type: Performance |
✅ | ✅ | Includes performance fixes |
⚡ | Improvement | Type: Improvement |
✅ | ✅ | Includes backwards-compatible fixes |
💥 | Breaking | Type: Breaking |
✅ | ✅ | Includes backwards-incompatible fixes |
Deprecated | Type: Deprecated |
✅ | ✅ | Includes deprecate fixes | |
🌐 | I18n | Type: I18n |
✅ | ✅ | An internationalization fixes |
♿ | A11y | Type: A11y |
✅ | ✅ | An accessibility fixes |
📝 | Documentation | Type: Documentation |
✅ | ✅ | A documetation fixes |
👕 | Refactoring | Type: Refactoring |
✅ | A code change that neither fixes a bug nor adds a feature | |
✅ | Testing | Type: Testing |
✅ | Adding missing tests or correcting existing tests | |
🔧 | Maintenance | Type: Maintenance |
✅ | Repository Maintenance | |
🍭 | Example | Type: Example |
✅ | Includes example and demo code fixes | |
📌 | Dependency | Type: Dependency |
✅ | Dependencies fixes | |
📦 | Build | Type: Build |
✅ | A packaging or a building fixes |
You can use the preset as default
or full
. In about setup, look up the following CLI section.
You can setup lerna-changelog labels to package.json
with CLI.
npm:
$ npm install -g lerna-changelog-label-schema
yarn:
$ yarn global add lerna-changelog-label-schema
Label schema definition for lerna-changelog
Usage
$ lerna-changelog-label-schema <command> [options]
Commands:
define, d define lerna-changelog labels in your package.json
generate, g generate lerna-changelog labels for GitHub labels, output for stdout
version, v show the version
Options:
--preset, -p Label schema preset option, for define and generate command. 'default' or 'full', default: 'default'
--output, -o Output option, for generate command. if specified, stdout is suppressed.
Examples:
$ lerna-changelog-label-schema define --preset=full
$ lerna-changelog-label-schema generate --preset=default
e.g. define
command
$ cd /path/to/project
$ lerna-changelog-label-schema define --preset=full
apply lerna-changelog label schema 'full' to package.json
Details changes for each release are documented in the CHANGELOG.md.