Fully automated commit and release workflows with Commitizen and Semantic Release
This package is a batteries included manager for setting up standardized commit messages with [Commitizen][] and automated CI/CD releases with [Semantic Release]. - Standardized commit messages are constructed using an interactive prompt with options for long descriptions, emojis, breaking change notes and release notes. - Fully automated releases include package version and changelog updates, npm publishing, and Github release comments and labels. --- ## âī¸ Setup _1. Install_ ```sh npm i -D @crystal-ball/commit-semantics husky ``` _2. Configure `package.json`_ ```json { "config": { "commitizen": { "path": "@crystal-ball/commitizen-adapter" } }, "husky": { "hooks": { "prepare-commit-msg": "exec < /dev/tty && git cz --hook" } }, "release": { "extends": ["@crystal-ball/semantic-release-base"] } } ``` _3. Configure `.github/workflows/ci-cd.yml`_ ```yml # Release with Semantic after tests pass on master jobs: ci-cd: runs-on: ubuntu-latest steps: - name: Release if: success() && github.ref == 'refs/heads/master' run: npx semantic-release env: GH_TOKEN: ${{ secrets.SEMANTIC_GH_TOKEN }} NPM_TOKEN: ${{ secrets.SEMANTIC_NPM_TOKEN }} ``` This configuration will run `semantic-release` on any change to the master branch. Commit types of `New`, `Update` and `Fix`, or any commit containing a `BREAKING CHANGES` footer will trigger a release. _4. Configure Secret_ `SEMANTIC_GH_TOKEN` and `SEMANTIC_NPM_TOKEN` access tokens for npm and Github should be added to the secrets in the repo settings.  ## đ Commit standards Fully automated releases are only possible by following a standard commit message format that can be parsed when the release job is run. The ESLint format is used and must follow the pattern: ```