remarkablemark / conventional-release-setup

:rocket: Sets up package for committing and releasing with conventional commits.

conventional-release-setup

Sets up an npm project for committing and releasing with Conventional Commits:

npx conventional-release-setup@latest

Usage

Run the CLI:

npx conventional-release-setup

Or install the CLI globally and run:

npm install --global conventional-release-setup
conventional-release-setup

If you want to release with standard-version, then use v1:

npx conventional-release-setup@1

What It Does

The script:

• updates package.json:
  • version
    • appends -alpha
  • scripts
    • prepends release with husky install
• installs devDependencies:
  • @commitlint/cli - lints commit messages
  • @commitlint/config-conventional - config with conventional commits rules
  • husky - sets up git hooks
• copies the configs:
  • .github/workflows/release-please.yml - generates changelog, bumps version, and creates git commit, tag, and release
  • .commitlintrc.json
• adds husky hook commit-msg

Release

Release is automated with Release Please.

License

MIT