https://github.com/remarkablemark/conventional-release-setup

:rocket: Sets up package for committing and releasing with conventional commits.
https://github.com/remarkablemark/conventional-release-setup

cli commitlint conventional-commits executable husky npm package standard-version

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/remarkablemark/conventional-release-setup
• Owner: remarkablemark
• License: mit
• Created: 2020-02-17T05:22:19.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T08:50:05.000Z (8 months ago)
• Last Synced: 2024-10-29T10:00:22.920Z (8 months ago)
• Topics: cli, commitlint, conventional-commits, executable, husky, npm, package, standard-version
• Language: JavaScript
• Homepage: https://npmjs.com/package/conventional-release-setup
• Size: 1.67 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# conventional-release-setup

[![NPM](https://nodei.co/npm/conventional-release-setup.png)](https://nodei.co/npm/conventional-release-setup/)

[![NPM version](https://img.shields.io/npm/v/conventional-release-setup.svg)](https://www.npmjs.com/package/conventional-release-setup)

[![build](https://github.com/remarkablemark/conventional-release-setup/actions/workflows/build.yml/badge.svg)](https://github.com/remarkablemark/conventional-release-setup/actions/workflows/build.yml)

[![codecov](https://codecov.io/gh/remarkablemark/conventional-release-setup/graph/badge.svg?token=9U6TQRNAZ9)](https://codecov.io/gh/remarkablemark/conventional-release-setup)

Sets up an npm project for committing and releasing with [Conventional Commits](https://www.conventionalcommits.org/):

```sh

npx conventional-release-setup@latest

```

## Usage

Run the CLI:

```sh

npx conventional-release-setup

```

Or install the CLI globally and run:

```sh

npm install --global conventional-release-setup

conventional-release-setup

```

If you want to release with [standard-version](https://www.npmjs.com/package/standard-version), then use v1:

```sh

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](https://www.npmjs.com/package/@commitlint/cli) - lints commit messages

  - [@commitlint/config-conventional](https://www.npmjs.com/package/@commitlint/config-conventional) - config with [conventional commits](https://conventionalcommits.org/) rules

  - [husky](https://www.npmjs.com/package/husky) - sets up git hooks

- copies the configs:

  - [.github/workflows/release-please.yml](https://github.com/googleapis/release-please-action) - generates changelog, bumps version, and creates git commit, tag, and release

  - [.commitlintrc.json](https://github.com/remarkablemark/conventional-release-setup/blob/master/files/.commitlintrc.json)

- adds husky hook `commit-msg`

## Release

Release is automated with [Release Please](https://github.com/googleapis/release-please-action).

## License

[MIT](https://github.com/remarkablemark/conventional-release-setup/blob/master/LICENSE)