A changelog configuration for Semantic Release that supports emojis

Table of Contents

• Overview
• Requirements
  • Developer Requirements
• Configuration File
• Contributing
• License

Overview

This changelog is included in semantic-release-config. It supports emojis and is intended to work with commits submitted using git-cz with the cz-emoji-conventional configuration. This fork borrows the majority of its code from gitmoji-commit-workflow with some modifications intended to make the CHANGELOG.md look good on both GitLab and GitHub. Normally, you can only publish releases to either GitLab or GitHub but leveraging our custom semantic-release-gh plugin instead of the Semantic-branded plugin, you can post your releases to both GitLab and GitHub.

Requirements

If you are simply including this library in your project, all you need is a recent version of Node.js. Node.js >14.18.0 is sometimes required and is the only version range we actively support. Albeit, it is highly probable that lower versions will work as well depending on the requirements that this project imports.

Developer Requirements

The following versions of Node.js and Python are required for development:

• Node.js >14.18.0
• Python >3.10.0

Other versions may work, but only the above versions are supported. Most development dependencies are installed automatically by our Taskfile.yml set-up (even Node.js and Python). Run bash start.sh to install Bodega (an improved fork of go-task) and run the initialization sequence. The taskfiles will automatically install dependencies as they are needed, based on what development tasks you are running. For more information, check out the CONTRIBUTING.md or simply run:

npm run help

npm run help will ensure Bodega is installed and then open an interactive dialog where you can explore and learn about various developer commands.

Configuration File

conventional-changelog-emoji-config uses cosmiconfig to find and load your configuration object. Starting from the current working directory, it looks for the following possible sources:

• a changelog property in package.json
• a .changelogrc file
• a changelog.config.js file exporting a JS object

The .changelogrc file (without extension) can be in JSON or YAML format. You can add a filename extension to help your text editor provide syntax checking and highlighting:

• .changelogrc.json
• .changelogrc.yaml / .changelogrc.yml
• .changelogrc.js

The configuration object has the following signature:

interface ChangelogConfig {
  /**
   * map the scope to display name
   *
   * for example
   * {
   *     'config': 'commitlint-gitmoji-config'
   * }
   * will map all config 'scope' to 'commitlint-gitmoji-config' in the changelog
   * @default { }
   */
  scopeDisplayName?: Record<string, string>
  /**
   * display types
   * @default undefined
   */
  displayTypes?: string[]
  /**
   * whether to include emoji in title
   * @default true
   */
  withEmoji?: boolean
  /**
   * whether to show author
   * @default false
   */
  showAuthor?: boolean
}

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page. If you would like to contribute, please take a look at the contributing guide.

Brian Zalewski

License

Copyright © 2020-2021 Megabyte LLC. This project is MIT licensed.