# conventional-changelog

**Repository Path**: vuejs/conventional-changelog

## Basic Information

- **Project Name**: conventional-changelog
- **Description**: Preset for conventional-changelog
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-08-03
- **Last Updated**: 2025-08-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# @vue/conventional-changelog

Custom preset for [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog/) which groups changes by package (`packages/@vue/xxx`). It works by getting the package which has the highest number of changed files in each commit.

```bash
yarn add -D @vue/conventional-changelog
```

Example usage:

```js
const execa = require('execa')
const cc = require('conventional-changelog')
const config = require('@vue/conventional-changelog')

const gen = module.exports = version => {
  const fileStream = require('fs').createWriteStream(`CHANGELOG.md`)

  cc({
    config,
    releaseCount: 0,
    pkg: {
      transform (pkg) {
        pkg.version = `v${version}`
        return pkg
      }
    }
  }).pipe(fileStream).on('close', async () => {
    delete process.env.PREFIX
    await execa('git', ['add', '-A'], { stdio: 'inherit' })
    await execa('git', ['commit', '-m', `chore: ${version} changelog [ci skip]`], { stdio: 'inherit' })
  })
}

if (process.argv[2] === 'run') {
  const version = require('../lerna.json').version
  gen(version)
}
```

[Result example](https://gist.github.com/Akryum/3cc2e3afaf5f7e730a3b9648b7ce4133)