nukengprodservice/release-tool

NUK工程生产力发布工具镜像文档

镜像概述

本镜像为NUK工程生产力团队提供的专用发布工具容器化方案，旨在简化工程团队的软件发布流程，通过标准化工具环境和自动化流程，降低发布操作复杂度，提升团队发布效率与协作生产力。

核心功能与特性

• 发布流程自动化：支持自定义发布步骤配置，自动执行构建、测试、版本号管理、部署等关键发布环节
• 版本管理集成：内置版本号生成与校验机制，支持语义化版本规范，自动记录版本变更历史
• 跨环境适配：兼容开发、测试、生产等多环境发布需求，支持环境配置隔离与切换
• 发布记录追踪：自动生成发布日志，记录发布时间、执行人、版本信息、变更内容等关键数据，便于审计与回溯
• 轻量级部署：基于精简基础镜像构建，体积小、启动快，可快速集成至现有工作流

使用场景与适用范围

• 工程团队日常发布：适用于中小型工程团队进行软件版本迭代发布操作
• CI/CD流程集成：可作为持续集成/持续部署管道中的关键组件，与Jenkins、GitLab CI等工具联动实现自动化发布
• 多项目管理：支持多项目配置隔离，可同时管理多个软件项目的发布流程
• 协作开发场景：帮助团队成员在统一工具环境下协作，减少因本地环境差异导致的发布问题

使用方法与配置说明

基础使用命令

bash
docker run -d \
  --name release-tool \
  -v /path/to/local/config:/app/config \
  -e API_TOKEN="your-release-system-token" \
  -e PROJECT_ID="target-project-id" \
  nuk/release-tool:latest

环境变量配置

配置文件挂载

工具支持通过挂载本地配置文件自定义发布流程，配置文件为YAML格式，示例路径：

bash
-v /local/path/release-config.yaml:/app/config/release-config.yaml

配置文件基本结构示例：

yaml
steps:
  - name: "代码拉取"
    type: "git"
    params:
      repo_url: "https://github.com/nuk/project.git"
      branch: "main"
  - name: "构建打包"
    type: "build"
    params:
      build_cmd: "make package"
  - name: "部署验证"
    type: "deploy"
    params:
      target_env: "${RELEASE_ENV}"
      verify_timeout: 300

数据持久化

如需持久化发布记录与日志，可挂载数据卷：

bash
-v release-tool-data:/app/data

数据卷包含发布历史日志、版本记录、临时构建产物等数据。

注意事项

• 首次使用需确保API_TOKEN具有目标项目的发布权限
• 自定义配置文件需符合工具YAML schema规范，错误配置将导致发布流程中断
• 生产环境发布建议通过RELEASE_ENV=prod显式指定，并启用二次确认机制（需在配置文件中额外配置）