@agility-luhn/release-config
v2.3.0
Published
Shared semantic-release configuration factory for LUHN packages
Downloads
1,148
Readme
@agility-luhn/release-config
Shared semantic-release configuration factory for LUHN packages.
Installation
pnpm install --save-dev @agility-luhn/release-configUsage
Create a release.config.cjs file in your package:
module.exports = require('@agility-luhn/release-config')('package-name');Replace 'package-name' with your package name (e.g., 'cli', 'compiler', 'database').
This will:
- Use
package-name-v${version}as the tag format - Generate changelogs in
CHANGELOG.md - Publish to npm automatically
- Commit changes back to git with semantic version tag
- Create GitHub releases
Configuration
The configuration includes:
- Commit Analyzer: Analyzes conventional commits
- Release Notes Generator: Generates release notes
- Changelog: Creates/updates
CHANGELOG.md - NPM: Publishes to npm registry
- Git: Commits changes back to repository
- GitHub: Creates GitHub releases
Example
For a package named cli:
// cli/release.config.cjs
module.exports = require('../release-config')('cli');This will:
- Tag:
cli-v1.5.5 - Message:
chore(release): cli 1.5.5 [skip ci]
License
MIT
