Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/megabyte-labs/conventional-changelog-emoji-config

🚀 A changelog configuration for Semantic Release that supports emojis
https://github.com/megabyte-labs/conventional-changelog-emoji-config

changelog config conventional-changelog emoji gitmoji mblabs megabytelabs preset professormanhattan washingtondc

Last synced: about 1 month ago
JSON representation

🚀 A changelog configuration for Semantic Release that supports emojis

Host: GitHub
URL: https://github.com/megabyte-labs/conventional-changelog-emoji-config
Owner: megabyte-labs
License: other
Created: 2022-02-11T08:08:43.000Z (almost 3 years ago)
Default Branch: master
Last Pushed: 2023-03-23T13:03:55.000Z (almost 2 years ago)
Last Synced: 2024-06-19T16:45:44.207Z (6 months ago)
Topics: changelog, config, conventional-changelog, emoji, gitmoji, mblabs, megabytelabs, preset, professormanhattan, washingtondc
Language: Shell
Homepage: https://megabyte.space
Size: 2.77 MB
Stars: 3
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Codeowners: docs/CODEOWNERS

Awesome Lists containing this project

README

Conventional Changelog Emoji Config

A configuration managed by Megabyte Labs

A changelog configuration for Semantic Release that supports emojis

## Table of Contents

- [Overview](#overview)
- [Requirements](#requirements)
- [Developer Requirements](#developer-requirements)
- [Configuration File](#configuration-file)
- [Contributing](#contributing)
- [Affiliates](#affiliates)
- [License](#license)

## Overview

This changelog is included in **[semantic-release-config](https://github.com/ProfessorManhattan/semantic-release-config)**. It supports emojis and is intended to work with commits submitted using [git-cz](https://www.npmjs.com/package/git-cz) with the [cz-emoji-conventional](https://www.npmjs.com/package/cz-emoji-conventional) configuration. This fork borrows the majority of its code from [gitmoji-commit-workflow](https://github.com/arvinxx/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](https://github.com/ProfessorManhattan/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](repository.project.node)** 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](repository.project.node)**
- **[Python >3.10.0](repository.project.python)**

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](https://github.com/ProfessorManhattan/Bodega)** (an improved fork of [go-task](https://github.com/go-task/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](https://github.com/megabyte-labs/conventional-changelog-emoji-config/blob/main/docs/CONTRIBUTING.md) or simply run:

```shell
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](https://github.com/davidtheclark/cosmiconfig#cosmiconfigsync) 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:

```typescript
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
/**
* 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](https://github.com/megabyte-labs/conventional-changelog-emoji-config/issues). If you would like to contribute, please take a look at the [contributing guide](https://github.com/megabyte-labs/conventional-changelog-emoji-config/blob/master/docs/CONTRIBUTING.md).

Sponsorship

Dear Awesome Person,

I create open source projects out of love. Although I have a job, shelter, and as much fast food as I can handle, it would still be pretty cool to be appreciated by the community for something I have spent a lot of time and money on. Please consider sponsoring me! Who knows? Maybe I will be able to quit my job and publish open source full time.

Sincerely,

**_Brian Zalewski_**

### Affiliates

Below you will find a list of services we leverage that offer special incentives for signing up for their services through our special links:

## License