smartive/semantic-release-image

semantic-release 镜像文档

镜像概述

本Docker镜像预安装了semantic-release及其常用插件，旨在提供开箱即用的自动化版本管理和发布解决方案。通过集成semantic-release核心功能与插件生态，帮助开发者简化版本号生成、变更日志管理、发布流程自动化等操作，适用于各类需要标准化版本控制的项目。

核心功能与特性

• 预安装核心组件：包含semantic-release主程序及常用插件，如@semantic-release/git（版本提交）、@semantic-release/npm（NPM发布）、@semantic-release/changelog（变更日志生成）、@semantic-release/github（GitHub发布）等
• 零配置启动：基础场景下无需额外安装依赖，直接运行即可触发版本管理流程
• 多环境兼容：支持在CI/CD管道、本地开发环境等多种场景下使用
• 灵活配置：可通过环境变量或配置文件自定义版本规则、发布目标等参数

使用场景与适用范围

• 自动化版本控制：需要根据提交信息（如Conventional Commits规范）自动生成版本号的项目
• 多平台发布：需同步发布到NPM、GitHub Releases、GitLab等多平台的项目
• CI/CD集成：在GitHub Actions、GitLab CI、Jenkins等CI/CD流程中集成版本发布步骤
• 团队协作：需要标准化版本管理流程，减少人工操作错误的团队项目

使用方法与配置说明

基础使用（docker run）

bash
docker run -v $(pwd):/app \
  -e GITHUB_TOKEN=<your-github-token> \
  -e NPM_TOKEN=<your-npm-token> \
  semantic-release-image:latest \
  semantic-release

docker-compose配置示例

yaml
version: '3'
services:
  release:
    image: semantic-release-image:latest
    volumes:
      - ./:/app
    environment:
      - GITHUB_TOKEN=${GITHUB_TOKEN}
      - NPM_TOKEN=${NPM_TOKEN}
      - SEMANTIC_RELEASE_CONFIG=/app/release.config.js
    command: semantic-release

环境变量配置

自定义配置文件

在项目根目录创建release.config.js文件自定义发布规则：

javascript
module.exports = {
  branches: ['main', 'next'], // 触发发布的分支
  plugins: [
    '@semantic-release/commit-analyzer', // 提交信息分析
    '@semantic-release/release-notes-generator', // 生成发布说明
    '@semantic-release/changelog', // 生成变更日志
    ['@semantic-release/npm', { npmPublish: true }], // NPM发布
    ['@semantic-release/git', { assets: ['package.json', 'CHANGELOG.md'] }], // 提交版本变更
    '@semantic-release/github' // GitHub Releases发布
  ]
}

常用命令

• 查看版本：docker run semantic-release-image:latest semantic-release --version
• 检查发布条件（不实际发布）：docker run -v $(pwd):/app semantic-release-image:latest semantic-release --dry-run
• 指定配置文件：docker run -v $(pwd):/app semantic-release-image:latest semantic-release --config /app/custom.config.js