https://github.com/hunghg255/changeloggithub

Generate Changelog
https://github.com/hunghg255/changeloggithub

changelog generate github-actions npm release

Last synced: about 2 months ago
JSON representation

Generate Changelog

• Host: GitHub
• URL: https://github.com/hunghg255/changeloggithub
• Owner: hunghg255
• License: mit
• Created: 2023-08-14T12:40:04.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-03T11:41:18.000Z (8 months ago)
• Last Synced: 2024-11-16T15:05:55.220Z (about 2 months ago)
• Topics: changelog, generate, github-actions, npm, release
• Language: TypeScript
• Homepage:
• Size: 189 KB
• Stars: 10
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        










  A script to generate changelog from github releases





  

  

  

  

  



Generate changelog for GitHub releases from [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), 

- Forked from [changelogithub](https://github.com/antfu/changelogithub)

- Forked from [changelogen](https://github.com/unjs/changelogen)

## Features

- 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 `--dry` mode to preview the changelog

- Support `--all` mode to write to a file

- Support `--from` and `--to` mode to write to a file between two tags

## Usage

In GitHub Actions:

- combined with [bumpp](https://npmjs.com/package/bumpp)

  

```yml

# .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: 18.x

      - run: npx changeloggithub@latest

        env:

          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

```

It will be trigged whenever you push a tag to GitHub that starts with `v`.

## Preview Locally

```bash

npx changeloggithub@latest --dry

```

## Write to a file

```bash

npx changeloggithub@latest --all true

```

## Write to a file between two tags

```bash

npx changeloggithub@latest --from v1.0.0 --to v2.0.0 --output changelog-v2.0.0.md

```