changelogiter
TypeScript icon, indicating that this package has built-in type declarations

0.0.2 • Public • Published

changelogiter

Generate changelog in GitHub GitLab anywhere, it's look like changelogithub.

NPM version

Features

  • Style look like antfu/changelogithub, thanks for Anthony Fu. (Changelog example);
  • Support exclamation mark as breaking change, e.g. chore!: drop node v10;
  • Grouped scope in changelog;
  • Create the release note, or update the existing one;
  • List contributors;
  • Support GitHub, GitLab and others, or just a .md file;

Quick start

Get a simple experience by installing changelogiter:

npm install changelogiter

npx changelogiter

Usage

changelogiter provides a variety of ways, you can choose the way you need:

Github Actions

# .github/workflows/release.yml

name: Release

permissions:
  contents: write

on:
  push:
    tags:
      - 'v*'

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0

      - uses: actions/setup-node@v3
        with:
          node-version: lts/*

      - run: npx changelogiter
        env:
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

Gitlab Runners

Only Output


License

MIT License © 2023-PRESENT Kaivan Wong

Package Sidebar

Install

npm i changelogiter

Weekly Downloads

4

Version

0.0.2

License

MIT License

Unpacked Size

44.4 kB

Total Files

14

Last publish

Collaborators

  • kaivanwong