Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@endemolshinegroup/cz-github

A Commitizen adapter for GitHub

commitizen, commitizen-adapter, github, typescript

readme

Banner

MIT Licensed NPM Version Build Status Dependabot Status

Code Issues Codebase Maintainability Test Coverage Jest

Commitizen Semantic Release Prettier

A Commitizen adapter for GitHub

Installation

yarn add -D @endemolshinegroup/cz-github

Add the following to your .czrc:

{
  "path": "@endemolshinegroup/cz-github"
}

Usage

asciicast

Configuration

The adapter can be customised by specifying additional options in .czrc:

{
  "path": "@endemolshinegroup/cz-github",
  "@endemolshinegroup/cz-github": {
    "scopes": {
      "api": "For API commits",
      "site": "For frontend commits",
      "docs": "For documentation commits"
    }
  }
}

changelog

2.0.0 (2020-06-21)

Bug Fixes

  • validation: change header max length to 72 (c98d52d)

Build System

  • change minimum supported Node version (d392e42)

Features

BREAKING CHANGES

  • change minimum supported version of Node to v10

1.0.5 (2018-11-03)

Bug Fixes

  • validation: only check if first word of subject is lowercase (20d7057)

1.0.4 (2018-11-02)

Bug Fixes

  • add more branch prefixes to remove (5444029)
  • validation: improve issue validation (38dcea8)

1.0.3 (2018-10-21)

Bug Fixes

  • prefix issue IDs retrieved from branch name with # (7035ce8), closes #5

1.0.2 (2018-10-19)

Bug Fixes

  • validation: fix for subject and lowercase validation (fbd2cc1)

1.0.1 (2018-10-14)

Bug Fixes

  • package: use correct keywords (f39a2c9)

1.0.0 (2018-10-14)

Bug Fixes

  • release: trigger a new release (33cfc29)