@insurgent/conventional-changelog-preset
Advanced tools
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:
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
{
"plugins": [
[
"@semantic-release/commit-analyzer",
{
"config": "@insurgent/conventional-changelog-preset",
"releaseRules": "@insurgent/conventional-changelog-preset/release-rules"
}
]
]
}
{
"plugins": [
[
"@semantic-release/release-notes-generator",
{
"config": "@insurgent/conventional-changelog-preset"
}
]
]
}
npm install --save-dev conventional-changelog
import conventionalChangelog from 'conventional-changelog';
const config = require('@insurgent/conventional-changelog-preset');
conventionalChangelog({ config }).pipe(process.stdout);
| 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 |
10.0.0 (2024-06-08)
FAQs
conventional-changelog preset
The npm package @insurgent/conventional-changelog-preset receives a total of 152 weekly downloads. As such, @insurgent/conventional-changelog-preset popularity was classified as not popular.
We found that @insurgent/conventional-changelog-preset demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
The Socket Research Team has discovered six new malicious npm packages linked to North Korea’s Lazarus Group, designed to steal credentials and deploy backdoors.
Security News
Socket CEO Feross Aboukhadijeh discusses the open web, open source security, and how Socket tackles software supply chain attacks on The Pair Program podcast.
Security News
Opengrep continues building momentum with the alpha release of its Playground tool, demonstrating the project's rapid evolution just two months after its initial launch.