访问官网
Githubchangelogithub
基于约定式提交为GitHub发布生成更新日志，由changelogen提供支持。
特性
- 支持使用感叹号表示重大变更，例如
chore!: 停止支持node v10 - 在更新日志中对作用域进行分组
- 创建发布说明，或更新现有的说明
- 列出贡献者
使用方法
在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: 16.x
- run: npx changelogithub # 或使用 changelogithub@0.12 以确保稳定结果
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
每当你向GitHub推送以v开头的标签时，它就会被触发。
配置
你可以在项目根目录放置一个名为changelogithub.config.{json,ts,js,mjs,cjs}或.changelogithubrc的配置文件，或者在package.json中使用changelogithub字段。
本地预览
npx changelogithub --dry
为什么要创建这个项目？
我曾经在几乎所有的项目中使用conventional-github-releaser。直到我发现它不支持使用感叹号表示重大变更 - 这会在维护者不知情的情况下，在更新日志中隐藏那些重要的重大变更。
许可证
MIT 许可证 © 2022 Anthony Fu
