voxpupuli/semantic-release

Voxpupuli Semantic Release容器

https://github.com/voxpupuli/container-semantic-release/actions/workflows/ci.yaml/badge.svg](https://github.com/voxpupuli/container-semantic-release/actions/workflows/ci.yaml) https://img.shields.io/github/license/voxpupuli/container-semantic-release.svg](https://github.com/voxpupuli/container-semantic-release/blob/main/LICENSE) https://img.shields.io/badge/Sponsored%20by-betadots%20GmbH-blue.svg]([***]

概述

该容器用于创建项目发布，封装了https://semantic-release.gitbook.io/semantic-release%E5%8F%8A%E6%89%80%E6%9C%89%E5%BF%85%E8%A6%81%E6%8F%92%E4%BB%B6%EF%BC%88%E8%AF%A6%E8%A7%81package.json%EF%BC%89%E3%80%82%E8%BF%99%E6%98%AF%E4%B8%80%E4%B8%AA%E8%BF%90%E8%A1%8C%E5%9C%A8Alpine%E5%AE%B9%E5%99%A8%E4%B8%AD%E7%9A%84npm%E5%BA%94%E7%94%A8%EF%BC%8C%E6%8F%90%E4%BE%9B%E8%87%AA%E5%8A%A8%E5%8C%96%E7%89%88%E6%9C%AC%E7%AE%A1%E7%90%86%E3%80%81%E5%8F%98%E6%9B%B4%E6%97%A5%E5%BF%97%E7%94%9F%E6%88%90%E5%92%8C%E5%8F%91%E5%B8%83%E6%B5%81%E7%A8%8B%E3%80%82

核心功能与特性

• 集成semantic-release实现自动化版本控制
• 包含conventional-changelog用于生成变更日志
• 提供commit-and-tag-version进行版本标记
• 支持自定义发布规则和配置
• 内置RocketChat和Mattermost通知功能
• 可添加自定义SSL证书

使用场景

• 项目自动化发布流程
• CI/CD管道中的版本管理
• 变更日志自动生成
• 跨团队协作时的发布通知

使用方法

容器中的主要工具

• conventional-changelog
• semantic-release
• commit-and-tag-version

更多信息参见package.json

运行工具

shell
# semantic-release为默认入口点
podman run -it --rm -v $PWD:/data:Z ghcr.io/voxpupuli/semantic-release:latest

# 运行commit-and-tag-version
podman run -it --rm -v $PWD:/data:Z --entrypoint commit-and-tag-version ghcr.io/voxpupuli/semantic-release:latest -r v2.0.0 --skip.commit --skip.tag

# 运行conventional-changelog
podman run -it --rm -v $PWD:/data:Z --entrypoint conventional-changelog ghcr.io/voxpupuli/semantic-release:latest -p angular -i CHANGELOG.md

环境变量

容器预定义了以下环境变量：

示例配置文件

.releaserc.yaml

以下是使用semantic-release的项目配置文件示例：

yaml
---
branches:
 - 'main'
 - 'master'
 - 'production'

ci: true
debug: true
dryRun: false
preset: 'conventionalcommits'

gitlabUrl: 'https://gitlab.example.com'
gitlabApiPathPrefix: '/api/v4'

plugins:
  - path: '@semantic-release/commit-analyzer'
    releaseRules:
      - { breaking: true, release: major }
      - { type: build,    release: patch }
      - { type: chore,    release: false }
      - { type: ci,       release: false }
      - { type: dep,      release: patch }
      - { type: docs,     release: patch }
      - { type: feat,     release: minor }
      - { type: fix,      release: patch }
      - { type: perf,     release: patch }
      - { type: refactor, release: false }
      - { type: revert,   release: patch }
      - { type: test,     release: false }

  - path: '@semantic-release/release-notes-generator'
    writerOpts:
      groupBy: 'type'
      commitGroupsSort: 'title'
      commitsSort: 'header'
    parserOpts:
      # 检测合并提交中的JIRA问题
      issuePrefixes: ['SUP', 'BUG', 'FEATURE']
      noteKeywords: ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
    presetConfig:
      issueUrlFormat: "https://jira.example.com/browse/{{prefix}}{{id}}"
      types:
        - { type: 'build',    section: '👷 Build' }
        - { type: 'chore',    section: '🧹 Chores' }
        - { type: 'ci',       section: '🚦 CI/CD' }
        - { type: 'dep',      section: '👾 Dependencies' }
        - { type: 'docs',     section: '📚 Docs' }
        - { type: 'feat',     section: '🚀 Features' }
        - { type: 'fix',      section: '🛠️ Fixes' }
        - { type: 'perf',     section: '⏩ Performance' }
        - { type: 'refactor', section: '🔨 Refactor' }
        - { type: 'revert',   section: '🙅 Reverts' }
        - { type: 'test',     section: '🚥 Tests' }

  - path: '@semantic-release/changelog'
    changelogFile: 'CHANGELOG.md'

  - path: '@semantic-release/git'
    assets:
      - 'CHANGELOG.md'

verifyConditions:
  - '@semantic-release/changelog'
  - '@semantic-release/git'

.versionrc.json

以下是使用commit-and-tag-version的项目配置文件示例：

json
{
  "types": [
    { "type": "build",    "section": "👷 Build" },
    { "type": "chore",    "section": "🧹 Chores" },
    { "type": "ci",       "section": "🚦 CI/CD" },
    { "type": "dep",      "section": "👾 Dependencies" },
    { "type": "docs",     "section": "📚 Docs" },
    { "type": "feat",     "section": "🚀 Features" },
    { "type": "fix",      "section": "🛠️ Fixes" },
    { "type": "perf",     "section": "⏩ Performance" },
    { "type": "refactor", "section": "🔨 Refactor" },
    { "type": "revert",   "section": "🙅 Reverts" },
    { "type": "test",     "section": "🚥 Tests" }
  ]
}

更新Puppet模块的metadata.json

基于上述配置示例，更新Puppet模块版本：

yaml
plugins:
#...
  - path: 'semantic-release-replace-plugin'
    replacements:
      - files: ['metadata.json']
        from: "\"version\": \".*\""
        to: "\"version\": \"${nextRelease.version}\""
        countMatches: true
        results:
          - file: 'metadata.json'
            hasChanged: true
            numMatches: 1
            numReplacements: 1
#...
  - path: '@semantic-release/git'
    assets:
      # ...
      - 'metadata.json'

Gitlab集成

以下是在Gitlab中使用该容器的示例配置，需确保项目中包含：

• .releaserc文件（支持YAML/JSON等格式）
• release.config.(js|cjs|.mjs)文件
• package.json中的release配置项

yaml
---
release:
  stage: Release🚀
  image:
    name: ghcr.io/voxpupuli/semantic-release:latest
    entrypoint: [""]  # 覆盖入口点 - gitlab-ci特性
    pull_policy:
      - always
      - if-not-present
  interruptible: true
  script:
    - /container-entrypoint.sh
  rules:
    - if: $CI_COMMIT_BRANCH == "master"
    - if: $CI_COMMIT_BRANCH == "main"
    - if: $CI_COMMIT_BRANCH == "production"

以本地用户身份运行

使用git+ssh远程仓库时，可能会遇到访问问题。以下命令启动本地ssh-agent，添加SSH密钥，并将相关文件挂载到容器中：

shell
eval $(ssh-agent)
ssh-add

podman run -it --rm \
  -v $PWD:/data:Z \
  -v ~/.gitconfig:/etc/gitconfig:Z \
  -v ~/.ssh:/root/.ssh:Z \
  -v ${SSH_AUTH_SOCK}:${SSH_AUTH_SOCK} \
  -e SSH_AUTH_SOCK="${SSH_AUTH_SOCK}" \
  ghcr.io/voxpupuli/semantic-release:latest --dry-run --no-ci

通知功能

RocketChat

容器中包含通过curl发送通知到RocketChat的脚本，需提供RocketChat钩子链接。脚本参数：

• -V: 指定要宣布的版本
• -o: 额外的curl参数（如--insecure）
• -d: 启用调试输出

脚本使用以下环境变量：

• ROCKETCHAT_EMOJI
• ROCKETCHAT_MESSAGE_TEXT
• ROCKETCHAT_TAGS_URL
• ROCKETCHAT_HOOK_URL

Mattermost

容器中包含通过curl发送通知到Mattermost的脚本，需提供Mattermost钩子链接。脚本参数同上，使用以下环境变量：

• MATTERMOST_EMOJI
• MATTERMOST_MESSAGE_TEXT
• MATTERMOST_TAGS_URL
• MATTERMOST_HOOK_URL
• MATTERMOST_USERNAME

配置示例

.releaserc.yaml:

yaml
---
# ...
plugins:
# 选择以下其中一种：
# ...
  - path: '@semantic-release/exec'
    publishCmd: "/scripts/notify-rocketchat.sh -V v${nextRelease.version} -o '--insecure' -d"
# ...
  - path: '@semantic-release/exec'
    publishCmd: "/scripts/notify-mattermost.sh -V v${nextRelease.version} -o '--insecure' -d"
# ...

.gitlab-ci.yml:

yaml
---
release:
# 选择以下其中一种：
# ...
  variables:
    ROCKETCHAT_NOTIFY_TOKEN: "隐藏的CI变量，不暴露令牌"
    ROCKETCHAT_EMOJI: ":tada:"
    ROCKETCHAT_MESSAGE_TEXT: "项目 ${CI_PROJECT_NAME} 的新标签由 ${GITLAB_USER_NAME} 创建。"
    ROCKETCHAT_HOOK_URL: "https://rocketchat.example.com/hooks/${ROCKETCHAT_NOTIFY_TOKEN}"
    ROCKETCHAT_TAGS_URL: "${CI_PROJECT_URL}/-/tags"
# ...
    MATTERMOST_NOTIFY_TOKEN: "隐藏的CI变量，不暴露令牌"
    MATTERMOST_EMOJI: ":tada:"
    MATTERMOST_MESSAGE_TEXT: "项目 ${CI_PROJECT_NAME} 的新标签由 ${GITLAB_USER_NAME} 创建。"
    MATTERMOST_HOOK_URL: "https://mattermost.example.com/hooks/${MATTERMOST_NOTIFY_TOKEN}"
    MATTERMOST_TAGS_URL: "${CI_PROJECT_URL}/-/tags"
    MATTERMOST_USERNAME: "Semantic Release [Bot]"
# ...

通知效果示例：

text
15:07 🤖 bot-account:
A new tag for the project dummy-module was created by Jon Doe.
Release v1.2.3

向容器添加额外证书

如需在容器中使用自定义证书，可通过入口点脚本添加。导出CERT_JSON环境变量，容器将在运行时导入证书。证书应为包含PEM格式证书的JSON哈希，建议压缩为单行。可在Github/Gitlab的CI变量中配置。

示例JSON：

json
{"certificates":{"root_ca":"-----BEGIN CERTIFICATE-----\n...","signing_ca":"-----BEGIN CERTIFICATE-----\n..."}}

更多详情参见container-entrypoint.sh和container-entrypoint.d。