https://github.com/jcamp-code/release-it-changelogen

🚀 Add @unjs/changelogen powered versioning and changelogs to Release It
https://github.com/jcamp-code/release-it-changelogen

Last synced: 23 days ago
JSON representation

🚀 Add @unjs/changelogen powered versioning and changelogs to Release It

• Host: GitHub
• URL: https://github.com/jcamp-code/release-it-changelogen
• Owner: jcamp-code
• License: mit
• Created: 2023-10-30T19:12:59.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-29T08:05:44.000Z (about 2 months ago)
• Last Synced: 2024-10-29T09:23:23.921Z (about 2 months ago)
• Language: TypeScript
• Homepage:
• Size: 166 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# release-it-changelogen

## unjs/changelogen powered versioning and changelog generation plugin for Release It!

This plugin adds the following with [Release It!](https://github.com/release-it/release-it)

- Enables semantic versioning (semver) and changelog generation,powered by [unjs/changelogen](https://github.com/unjs/changelogen)

- Enables [dotenv](https://github.com/motdotla/dotenv) integration automatically; no need to configure it separately

### Installation

```

npm install -D release-it-changelogen

```

In [release-it](https://github.com/release-it/release-it) config:

You also need to set git tag and commit messages to match semver. Currently, Release It plugins cannot update other plugin's options [Issue](https://github.com/release-it/release-it/issues/988)

```js

plugins: {

  'release-it-changelogen': {

    disableVersion: true

    templates: {

      commitMessage: "chore(release): v{{newVersion}}",

      tagMessage: "v{{newVersion}}",

      tagBody: "v{{newVersion}}",

    }

  },

  git: {

    tagName: 'v${version}',

    commitMessage: 'chore(release): v${version}',

    tagAnnotation: 'v${version}',

  },

}

```

### Configuration Options

#### `disableVersion`

Disables the recommended version provided by Changelogen

#### `bypassConfirm`

Skips the version confirmation prompt and always uses the version provided by Changelogen

#### All Other Options

Are passed to Changelogen; More information on available options can be found here: [changelogen](https://github.com/unjs/changelogen/blob/main/src/config.ts)