使用 semantic-release 和 GitHub Actions 自动集成 changelog

2023-12-17 03:40:40

前言

在软件开发中，changelog 是一个重要的文档，它记录了项目的每一次发布或更新。changelog 可以帮助用户了解项目的最新动态，并帮助开发团队跟踪项目的进展。传统上，changelog 是由开发人员手动维护的，这可能是一项耗时且容易出错的任务。

semantic-release 和 GitHub Actions 是两个可以帮助您自动化 changelog 生成过程的工具。semantic-release 是一个 Node.js 库，它可以根据您的提交信息自动生成 changelog。GitHub Actions 是一个持续集成平台，它可以自动执行各种任务，包括运行 semantic-release。

使用 semantic-release 和 GitHub Actions 自动集成 changelog

要使用 semantic-release 和 GitHub Actions 自动集成 changelog，您需要执行以下步骤：

安装 semantic-release。
配置 semantic-release。
创建一个 GitHub Actions 工作流。
将 GitHub Actions 工作流与 semantic-release 集成。

1. 安装 semantic-release

您可以使用以下命令安装 semantic-release：

npm install --save-dev semantic-release

2. 配置 semantic-release

在您的项目根目录下创建一个名为 .releaserc 的文件，并添加以下配置：

{
  "branches": ["main"],
  "plugins": ["@semantic-release/commit-analyzer", "@semantic-release/release-notes-generator", "@semantic-release/changelog", "@semantic-release/git"],
  "preset": "conventionalcommits"
}

3. 创建一个 GitHub Actions 工作流

在您的项目根目录下创建一个名为 .github/workflows/semantic-release.yml 的文件，并添加以下内容：

name: Semantic Release

on:
  push:
    branches: [main]

jobs:
  semantic-release:
    runs-on: ubuntu-latest
    steps:
      - name: Install dependencies
        run: npm install
      - name: Run semantic-release
        run: npx semantic-release