@wo-library/semantic-release-config
v1.0.0
Published
Semantic release config for github and npm, with Nx support
Readme
@wo-library/semantic-release-config
Shared release configuration for semantic-release and Nx release, using Conventional Commits.
Installation
yarn add --dev @wo-library/semantic-release-configUsage
semantic-release (.releaserc.cjs)
const config = require("@wo-library/semantic-release-config");
module.exports = config;Automatically publishes to npm, generates a CHANGELOG.md, creates a GitHub release
(when GITHUB_TOKEN is set), and bumps package.json.
Nx release (nx.json or nx.config.js)
const { getNxReleaseConfig } = require("@wo-library/semantic-release-config/nx");
module.exports = {
...getNxReleaseConfig({
projects: ["packages/*"],
createGitHubRelease: true,
}),
};Commit types → semver
| Type | Title | Bump |
| ---------- | ---------------- | ------------- |
| feat | ✨ Features | minor |
| fix | 🐛 Bug Fixes | patch |
| perf | ⚡️ Performance | patch |
| refactor | ♻️ Code Refactors | patch |
| docs | 📚 Documentation | patch |
| style | 🎨 Styles | none |
| test | 🚦 Tests | none |
| revert | Reverts | patch |
| chore | Chores | none (hidden) |
Known Issues
- Yarn PnP does not work when setting
presetfor@semantic-release/release-notes-generatortoconventionalcommits— the plugin usesimport-from-esminternally which cannot resolve packages under PnP. Use the default preset or run withnodeLinker: node-modules.
