@snomiao/setup-semantic-release
v1.2.0
Published
setup semantic-release for your project
Readme
@snomiao/setup-semantic-release
A tool to automatically set up semantic-release for your JavaScript/TypeScript projects.
Features
- ✅ Sets up semantic-release
- ✅ Configures Husky git hooks
- ✅ Adds GitHub Actions workflow for automated releases
- ✅ Easy one-command setup process
Installation
# Using bun
bun add @snomiao/setup-semantic-release -D
# Using npm
npm install @snomiao/setup-semantic-release --save-devUsage
Run the following command in the root directory of your git repository:
# Using bun
bunx @snomiao/setup-semantic-release
# Using npx
npx @snomiao/setup-semantic-releaseWhat It Does
When you run the setup command, it will:
- Check that you're in the root of a git repository
- Check that your git working tree is clean
- Install and configure Husky
- Install semantic-release dependencies
- Set up a GitHub Actions workflow for automated releases
- Commit the changes with "chore: setup semantic release"
Configuration
If you have an NPM_TOKEN environment variable set, it will automatically configure it as a GitHub secret for your repository. Otherwise, it will provide instructions on how to set it up manually.
Requirements
License
MIT © snomiao
