Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pvdlg/conventional-changelog-metahub
conventional-changelog preset
https://github.com/pvdlg/conventional-changelog-metahub
changelog conventional-changelog conventional-commits publish release semantic-release
Last synced: 4 days ago
JSON representation
conventional-changelog preset
- Host: GitHub
- URL: https://github.com/pvdlg/conventional-changelog-metahub
- Owner: pvdlg
- License: mit
- Created: 2017-08-21T03:03:21.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-05-13T12:57:44.000Z (about 3 years ago)
- Last Synced: 2024-06-18T14:11:00.481Z (18 days ago)
- Topics: changelog, conventional-changelog, conventional-commits, publish, release, semantic-release
- Language: JavaScript
- Homepage:
- Size: 160 KB
- Stars: 397
- Watchers: 7
- Forks: 40
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Lists
- awesome-resources - **Git Commit Types**
README
# **conventional-changelog-metahub**
[conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) preset built from a list of [conventional commit types](src/types.js) (similar to [conventional-commit-types](https://github.com/commitizen/conventional-commit-types)).
Also provides [release rules](https://github.com/pvdlg/sr-commit-analyzer#release-rules) configuration for [sr-commit-analyzer](https://github.com/pvdlg/sr-commit-analyzer).
[](https://travis-ci.org/pvdlg/conventional-changelog-metahub)
[](https://codecov.io/gh/pvdlg/conventional-changelog-metahub)
[](https://greenkeeper.io/)
Commit types originally from:
- [Angular Git Commit Message Conventions](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#type)
- [commitizen/cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog)
- [conventional-commit-types](https://github.com/commitizen/conventional-commit-types)
## Install
```bash
npm install --save-dev conventional-changelog-metahub
```
## Configuration for sr-commit-analyzer
```bash
npm install --save-dev sr-commit-analyzer
```
```json
{
"release": {
"analyzeCommits": {
"path": "sr-commit-analyzer",
"preset": "metahub",
"releaseRules": "conventional-changelog-metahub/release-rules"
}
}
}
```
## Configuration for sr-release-notes-generator
```bash
npm install --save-dev sr-release-notes-generator
```
```json
{
"release": {
"generateNotes": {
"path": "sr-release-notes-generator",
"preset": "metahub"
}
}
}
```
## Use with conventional-changelog
```bash
npm install --save-dev conventional-changelog
```
```js
import conventionalChangelog from 'conventional-changelog';
const config = require('conventional-changelog-metahub');
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` |
## Commit aliases
Aliases allow to have additional commit types (in a tool like [commitizen](https://github.com/commitizen/cz-cli) for example) that can be formatted to follow [AngularJS Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit).
For example the [commitizen](https://github.com/commitizen/cz-cli) CLI can present the choice `initial` and the final commit message will be 'feat: Initial commit 🎉'
| Commit Type | Maps to | Title | Description | Emoji |
|:------------------:| ------- | ----------------- | ------------------------------ |:------:|
| `initial` | `feat` | Initial | Initial commit | 🎉 |
| `dependencies` | `fix` | Dependencies | Update dependencies | ⬆️ |
| `peerDependencies` | `fix` | Peer dependencies | Update peer dependencies | ⬆️ |
| `devDependencies` | `chore` | Dev dependencies | Update development dependencies | ⬆️ |
| `metadata` | `fix` | Metadata | Update metadata (package.json) | 📦 |
## Related
- [cz-conventional-commit](https://github.com/pvdlg/cz-conventional-commit)
- [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog)