:package::rocket: semantic-release

全自动化的包/模块/镜像发布

这个项目旨在成为原始semantic-release实现的替代方案。使用Go语言编写的semantic-release可以通过下载单个二进制文件安装，因此更容易安装，并且不需要Node.js和npm。此外，semantic-release还具有内置的插件系统，可以扩展和自定义其功能。

特性

• 自动化版本和发布管理
• 无需外部依赖
• 在Linux、macOS和Windows上运行
• 通过插件完全可扩展
• 自动生成变更日志
• 支持GitHub、GitLab和git
• 支持维护多个主要版本发布

它是如何工作的？

与其写一些毫无意义的提交消息，我们可以花时间思考代码库中的变更并将它们记录下来。遵循约定式提交规范，就可以生成有用的变更日志，并从中推导出下一个语义化版本号。

当设置好semantic-release后，它会在每次成功构建默认分支后执行，并为您发布新版本。这样，没有人直接参与发布过程，您的发布保证是非浪漫和非情感化的。

来源：semantic-release/semantic-release#how-does-it-work

您可以使用git钩子来强制执行语义化提交消息。

安装

选项1：使用go-semantic-release GitHub Action（go-semantic-release/action）

选项2：手动安装

curl -SL https://get-release.xyz/semantic-release/linux/amd64 -o ./semantic-release && chmod +x ./semantic-release

选项3：通过npm安装

npm install -g go-semantic-release

示例

使用GitHub Actions发布Go应用程序

完整示例可以在go-semantic-release/example-go-application找到。

示例.github/workflows/ci.yml配置：

name: CI
on:
  push:
    branches:
      - '**'
  pull_request:
    branches:
      - '**'
jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-go@v3
        with:
          go-version: 1.19
      - uses: golangci/golangci-lint-action@v3
  test:
    runs-on: ubuntu-latest
    needs: lint
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-go@v3
        with:
          go-version: 1.19
      - run: go test -v ./...
  release:
    runs-on: ubuntu-latest
    needs: test
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-go@v3
        with:
          go-version: 1.19
      - uses: go-semantic-release/action@v1
        with:
          hooks: goreleaser
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

GitLab CI配置示例

GitLab令牌

需要在这里创建一个具有api作用域的新GitLab个人访问令牌。 确保CI变量是受保护和隐藏的，因为GITLAB_TOKEN具有很多权限。有一个关于项目特定令牌的未解决问题。 您可以通过GITLAB_TOKEN环境变量或-token标志设置GitLab令牌。

.gitlab-ci.yml

stages:
  # 其他阶段
  - release

release:
  image:
    name: registry.gitlab.com/go-semantic-release/semantic-release:latest
    entrypoint: [""]
  stage: release
  # when: manual # 如果您想手动创建发布，请添加此行
  only:
    - master
  script:
    - semantic-release # 如果您想为每次推送创建发布，请添加 --allow-no-changes

作业令牌

如果您不提供PAT，将使用作业令牌。 这个受限制的令牌可以创建发布，但无法读取提交。必须将git策略 设置为clone，以便我们可以从仓库中读取提交。请参见以下示例

.gitlab-ci.yml

variables:
  GIT_STRATEGY: clone

stages:
  # 其他阶段
  - release

release:
  image:
    name: registry.gitlab.com/go-semantic-release/semantic-release:latest
    entrypoint: [""]
  stage: release
  # when: manual # 如果您想手动创建发布，请添加此行
  only:
    - master
  script:
    - semantic-release
    # - semantic-release --allow-no-changes # 为每次推送创建发布
    # - semantic-release --provider gitlab --provider-opt log_order=ctime # 按提交者时间遍历提交（合并请求中的提交将影响计算的版本）

使用GitLab CI发布Go应用程序

完整示例可以在https://gitlab.com/go-semantic-release/example-go-application找到。

示例.gitlab-ci.yml配置：

image: golang:1.19

stages:
  - test
  - release

test:
  stage: test
  except:
    - tags
  script:
    - go test -v ./...
    - go build ./
    - ./example-go-application

release:
  stage: release
  only:
    - main
  script:
    - curl -SL https://get-release.xyz/semantic-release/linux/amd64 -o ./semantic-release && chmod +x ./semantic-release
    - ./semantic-release --hooks goreleaser

插件系统

从v2开始，semantic-release配备了插件系统。插件是使用hashicorp/go-plugin作为插件库的独立二进制文件。semantic-release会自动下载必要的插件（如果本地不存在）。插件存储在当前工作目录的.semrel目录中，格式如下：.semrel/<os>_<arch>/<plugin name>/<version>/。go-semantic-release插件注册表（https://registry.go-semantic-release.xyz/）用于解析插件并下载正确的二进制文件。借助新的[plugin-registry](https://github.com/go-semantic-release/plugin-registry)服务，API还支持批量请求以一次性解析多个插件，并支持插件缓存。

在离线环境中运行semantic-release

由于插件只有在.semrel文件夹中不存在时才会下载，因此可以下载插件并归档.semrel文件夹。这样就可以在离线环境中运行semantic-release。

# 指定所有必需的插件并下载它们
./semantic-release --download-plugins --show-progress --provider github --ci-condition github --hooks goreleaser
# 归档.semrel文件夹
tar -czvf ./semrel-plugins.tgz .semrel/

# 将归档文件复制到离线环境

# 解压归档文件
tar -xzvf ./semrel-plugins.tgz
# 运行semantic-release
./semantic-release --provider github --condition github --hooks goreleaser

插件

• 提供者 (文档)
  • GitHub
  • GitLab
  • Git
• CI 条件 (文档)
  • GitHub Actions
  • GitLab CI
  • Bitbucket Pipelines
  • 默认
• 提交分析器 (文档)
  • 约定式提交
• 更新日志生成器 (文档)
  • 默认
• 钩子 (文档)
  • GoReleaser
  • npm-binary-releaser
  • plugin-registry-update
  • exec
• 文件更新器 (文档)
  • npm
  • helm

配置

插件可以通过命令行标志或 .semrelrc 配置文件进行配置。通过在插件名称后使用 @ 符号，可以指定所需的插件版本。否则，将使用任何本地安装的版本。如果插件在本地不存在，将下载最新版本。以下是 .semrelrc 配置文件的示例：

{
  "plugins": {
    "commit-analyzer": {
      "name": "default@^1.0.0"
    },
    "ci-condition": {
      "name": "default"
    },
    "changelog-generator": {
      "name": "default",
      "options": {
        "emojis": "true"
      }
    },
    "provider": {
      "name": "gitlab",
      "options": {
        "gitlab_projectid": "123456"
      }
    },
    "files-updater": {
      "names": ["npm"]
    }
  }
}

Beta 版本支持

Beta 版本支持使您能够使用 semantic-release 发布 beta、rc 等版本（例如 v2.0.0-beta.1）。要启用此功能，您需要创建一个新分支（例如 beta/v2）并提交一个包含以下内容的 .semrelrc 文件：

{
  "maintainedVersion": "2-beta"
}

如果您提交到此分支，每次推送时都会创建一个新的递增预发布版本。（2.0.0-beta.1, 2.0.0-beta.2, ...）

许可证

MIT 许可证 (MIT)

版权所有 © 2024 Christoph Witzko