@142vip/changelog

根据git提交记录，自动生成CHANGELOG文档

从 GitHub 提交信息Conventional Commits中生成更改日志。 这个模块实现参考了changelogen和changelogithub两个模块的实现。

非常感谢两位作者的实现思路

• changelogen
• changelogithub

新功能

• 支持在CHANGELOG文档中标记破坏性改动
• CHANGELOG文档中支持按照scope进行分组展示
• 配合CI流水线，生成的CHANGELOG记录支持展示代码贡献者
• 支持Monorepo模式，通过scopeName配置，匹配git提交信息中的scope，过滤出组件包的提交记录

👉 使用示例

使用

生成CHANGELOG.md文档

# output参数可以配置，支持做本地文档更新
npx changelog --output CHANGELOG.md

本地预览

# 只本地生成创建版本的URL
npx changelog --dry

配合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@v4
        with:
          fetch-depth: 0

      # 安装node版本，大于16
      - uses: actions/setup-node@v4
        with:
          node-version: 16.x

      # Github发布版本，并更新Release信息
      - name: Release New Version
        run: |
          npx changelog
        env:
          GITHUB_TOKEN: ${{secrets.TOKEN}}

向 GitHub 推送以“v”开头的标签时，github actions会被触发。

在142vip所有的开源仓库中，都可以通过@142vip/changelog模块来实现发布，例如：

#
# CD持续交付
#

name: CD
on:
  push:
    branches:
      - next
  workflow_dispatch:
jobs:
  # 版本发布
  release:
    name: 创建Github发布
    runs-on: ubuntu-latest
    # 主库next且执行release更新时执行
    if: github.repository == '142vip/core-x' && startsWith(github.event.head_commit.message, 'chore(release):')

    steps:
      - name: Checkout Code
        uses: actions/checkout@v4
        with:
          persist-credentials: false
          # “最近更新时间” 等 git 日志相关信息，需要拉取全部提交记录
          fetch-depth: 0

      # 安装PNPM
      - name: PNPM Install
        uses: pnpm/action-setup@v4
        with:
          version: 7.33.2

      # 安装Node环境
      - name: Install Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 20.12.2
          # 淘宝镜像加速
          registry-url: 'https://registry.npmmirror.com'
          # 缓存
          cache: pnpm

      # 下载依赖，并执行初始化脚本：钩子函数、思维导图构建
      - name: Install Dependencies
        run: |
          ./scripts/ci

      - name: Build All Packages
        run: |
          pnpm build

      # Github发布版本，并更新Release信息
      - name: Release New Version
        run: |
          npx changelog
        env:
          GITHUB_TOKEN: ${{secrets.TOKEN}}

更多功能

# cli 参数帮助
npx changelog -h

@142vip/changelog/0.0.1-alpha.6

Usage: @142vip/changelog [options]

Options:
  -v --version             Package Version
  -t, --tokens <path>      GitHub Token
  --from <ref>             From tag
  --to <ref>               To tag
  --github <path>          GitHub Repository, e.g. @142vip/core-x
  --name <name>            Name of the release
  --prerelease             Mark release as prerelease
  --output <path>          Output to file instead of sending to GitHub
  --scopeName <scopeName>  Package name in Monorepo，Match the scope in the git commit information
  --dry                    Dry run (default: false)
  -h, --help               display help for command

配置

您可以将配置文件放在项目根目录中，名为 changelog.config.{json，ts，js，mjs，cjs}或使用 @142vip/changelog 字段在package.json中。

证书

MIT

Copyright (c) 2019-present, 142vip 储凡