😉 Use gitmoji commit in your workflow

English(TODO) | 中文

Gitmoji Commit Workflow is a tool designed to streamline and standardize the commit process using Gitmoji. It aims to provide a consistent and visually appealing way to manage commits, making it easier to understand the purpose of each commit at a glance.

• Standardized Commit Messages: Enforces a consistent commit message format using Gitmoji.
• Shareable Configurations: Provides shareable configurations for commitlint, conventional-changelog, and semantic-release.
• Helper Packages: Includes helper packages for parser options, commit types, and Gitmoji regex.

To install and set up Gitmoji Commit Workflow, follow these steps:

1. Clone the repository:

   git clone https://github.com/arvinxx/gitmoji-commit-workflow.git cd gitmoji-commit-workflow

2. Install dependencies:

   pnpm install

3. Configure your project to use the provided packages and configurations.

Here are some basic usage examples to get you started:

• Commitlint Configuration:

  echo "module.exports = {extends: ['gitmoji']};" > commitlint.config.js

• Conventional Changelog Configuration:

  // .releaserc.js module.exports = { extends: ['semantic-release-config-gitmoji'], };

• Semantic Release Configuration:

  // .releaserc.js const { createConfig } = require('semantic-release-config-gitmoji/lib/createConfig'); const config = createConfig({ monorepo: true }); module.exports = config;

Refer to this repository to get a template of Gitmoji Commit Workflow

Here are some packages for gitmoji commit workflow

Packages	Status	Description
commitlint-config-gitmoji		a shareable commitlint configuration to enforcing gitmoji commit
conventional-changelog-gitmoji-config		a shareable conventional-changelog configuration to generate changelog of gitmoji commit
semantic-release-config-gitmoji		a shareable conventional-changelog configuration to generate changelog of gitmoji commit

Packages	Status	Description
commitlint-plugin-gitmoji		a commitlint plugin to add gitmoji check rule
@gitmoji/parser-opts		a shareable parser options for gitmoji styles commit
@gitmoji/commit-types		gitmoji styles commit types
@gitmoji/gitmoji-regex		a gitmoji regex

The commitlint gitmoji repo is managed as a monorepo; it's composed of many npm packages.

The original commitlint-config-gitmoji repo can be found in packages/config.

MIT ® Arvin Xu