# .github/workflows/release.yml

name: Release

permissions:
  contents: write

on:
  push:
    tags:
      - 'v*'

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

      - name: Set node
        uses: actions/setup-node@v4
        with:
          registry-url: https://registry.npmjs.org/
          node-version: lts/*

      - run: npx changelogithub # or [email protected] to ensure a stable result
        env:
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

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

Configuration

You can put a configuration file in the project root, named as changelogithub.config.{json,ts,js,mjs,cjs}, .changelogithubrc or use the changelogithub field in package.json.

Preview Locally

npx changelogithub --dry

Why?

I used to use conventional-github-releaser for almost all my projects. Until I found that it does NOT support using exclamation marks for breaking changes - hiding those important breaking changes in the changelog without the awareness from maintainers.

License

版本列表

14.0.0 2025-11-25

13.16.1 2025-10-26

13.16.0 2025-06-17

13.15.0 2025-05-28

13.14.0 2025-05-14

13.13.0 2025-03-01

13.12.1 2025-01-15

0.13.11 2024-10-05

0.13.10 2024-08-24

0.13.9 2024-07-15

0.13.7 2024-04-15

0.13.6 2024-04-14

0.13.5 2024-03-21

0.13.4 2024-01-15

0.13.3 2024-01-15

0.13.2 2023-11-07

0.13.1 2023-10-08

0.13.0-beta.0 2023-09-05

0.13.0 2023-09-05

0.12.12 2023-06-13

0.12.11 2023-05-23

0.12.10 2023-05-22

0.12.9 2023-04-14

0.12.7 2022-12-15

0.12.6 2022-11-17

0.12.4 2022-07-05

0.12.3 2022-07-04

0.12.2 2022-07-04

0.12.1 2022-07-02

0.12.0 2022-07-02

0.11.0 2022-07-02

0.10.0 2022-07-01

0.9.1 2022-07-01

0.9.0 2022-06-30

0.8.1 2022-06-30

0.8.0 2022-06-30

0.7.2 2022-06-30

0.7.0 2022-06-21

0.6.6 2022-06-18

0.6.5 2022-06-15

0.6.4 2022-06-15

0.6.1 2022-06-15

0.6.0 2022-06-15

0.5.1 2022-06-14

0.5.0 2022-06-14

0.4.0 2022-06-13

0.3.0 2022-06-13

0.2.1 2022-06-13

0.2.0 2022-06-13

0.1.10 2022-06-13

0.1.9 2022-06-13

0.1.8 2022-06-13

0.1.7 2022-06-13

0.1.6 2022-06-13

0.1.5 2022-06-13

0.1.4 2022-06-13

0.1.3 2022-06-13

0.1.2 2022-06-13

0.1.1 2022-06-13

0.1.0 2022-06-13

0.0.3-beta.4 2022-06-13

0.0.3-beta.3 2022-06-13

0.0.3-beta.2 2022-06-13

0.0.3-beta.1 2022-06-13

0.0.2-beta.1 2022-06-13

0.0.1 2022-06-13