sinlov/woodpecker-gitea-cc-release

Woodpecker Gitea 规范提交发布插件

镜像概述和主要用途

该镜像为Woodpecker CI/CD的插件，专门用于Gitea代码托管平台，支持基于规范提交日志（Conventional Commits）创建发布。通过该插件，用户可自动化完成发布文件上传、校验和生成、发布说明生成等流程，简化Gitea项目的发布管理。

核心功能和特性

• ✅ 支持Gitea版本 gitea >= 1.11
• ✅ 干运行模式（dry-run mode）
• ✅ 使用Gitea访问令牌（Access Token）进行认证
• ✅ 通过glob模式上传发布文件
• ✅ 生成多种校验和文件（支持md5、sha1、sha256、sha512、crc32等）
  • 校验和文件兼容md5sum、sha1sum等工具
  • 生成的校验和文件基于原文件名，避免重复
• ✅ 支持从CHANGELOG.md读取规范提交日志（基于github.com/convention-change/convention-change-log库）
  • 同时支持贡献者公约（Contributor Covenant）变更日志
• ✅ Docker平台支持（v1.2.+）：linux/amd64、linux/386、linux/arm64/v8、linux/arm/v7、linux/ppc64le、linux/s390x

使用场景和适用范围

适用于在Gitea平台上使用Woodpecker CI/CD流程的项目，需自动化创建发布、集成规范提交日志、上传发布文件及生成校验和的场景。尤其适合需要规范化发布流程、确保发布文件完整性的开发团队。

配置说明

常规设置

隐藏设置

使用示例

Docker后端工作流

yml
labels:
  backend: docker
steps:
  woodpecker-gitea-cc-release:
    image: sinlov/woodpecker-gitea-cc-release:latest # https://hub.docker.com/r/sinlov/woodpecker-gitea-cc-release
    pull: false
    settings:
      # debug: true
      gitea-api-key:
        from_secret: gitea_api_key_release
      # gitea-base-url: "" # 当`CI_FORGE_TYPE`为`gitea`且该值为空时，将尝试从环境变量`CI_FORGE_URL`获取
      gitea-dry-run: true # 启用干运行模式
      gitea-draft: true # 将发布标记为草稿
      gitea-prerelease: true # 将发布标记为预发布（默认值为true）
      gitea-release-files-globs:
        - "doc/*.md"
      gitea-release-file-exists-do: "skip" # 发布文件已存在时的处理方式，支持：[fail overwrite skip]（默认："fail"）
      gitea-files-checksum: # 生成指定类型的校验和，为空时跳过，支持：[md5 sha1 sha256 sha512 adler32 crc32 blake2b blake2s]
        - "md5"
        - "sha256"
        - "sha512"
      # gitea-release-note-by-convention-change: true # 通过规范变更日志生成发布说明，若为true将读取变更日志文件并覆盖gitea-release-note设置
      gitea-release-title: "dry run release" # 发布标题，为空时使用标签名，可被规范变更日志的标签名覆盖

本地后端工作流

需在本地安装插件并确保其在环境变量PATH中生效，可通过https://github.com/woodpecker-kit/woodpecker-gitea-cc-release/releases%E4%B8%8B%E8%BD%BD%E3%80%82

安装最新版本至${GOPATH}/bin

bash
go install -a github.com/woodpecker-kit/woodpecker-gitea-cc-release/cmd/woodpecker-gitea-cc-release@latest

安装指定版本（v1.0.0）至${GOPATH}/bin

bash
go install -v github.com/woodpecker-kit/woodpecker-gitea-cc-release/cmd/woodpecker-gitea-cc-release@v1.0.0

工作流配置

yml
labels:
  backend: local
steps:
  woodpecker-gitea-cc-release:
    image: woodpecker-gitea-cc-release
    settings:
      # debug: true
      gitea-api-key:
        from_secret: gitea_api_key_release
      # gitea-base-url: "" # 当`CI_FORGE_TYPE`为`gitea`且该值为空时，将尝试从环境变量`CI_FORGE_URL`获取
      gitea-dry-run: true # 启用干运行模式
      gitea-draft: true # 将发布标记为草稿
      gitea-prerelease: true # 将发布标记为预发布（默认值为true）
      gitea-release-files-globs:
        - "doc/*.md"
      gitea-release-file-exists-do: "skip" # 发布文件已存在时的处理方式，支持：[fail overwrite skip]（默认："fail"）
      gitea-files-checksum: # 生成指定类型的校验和，为空时跳过，支持：[md5 sha1 sha256 sha512 adler32 crc32 blake2b blake2s]
        - "md5"
        - "sha256"
        - "sha512"
      # gitea-release-note-by-convention-change: true # 通过规范变更日志生成发布说明，若为true将读取变更日志文件并覆盖gitea-release-note设置
      gitea-release-title: "dry run release" # 发布标题，为空时使用标签名，可被规范变更日志的标签名覆盖

完整配置示例

yml
labels:
  backend: docker
steps:
  woodpecker-gitea-cc-release:
    image: sinlov/woodpecker-gitea-cc-release:latest # https://hub.docker.com/r/sinlov/woodpecker-gitea-cc-release
    pull: false
    settings:
      # debug: true
      gitea-timeout-second: 120 # Gitea发布API超时时间（秒），默认60秒，最小值30秒
      gitea-api-key:
        from_secret: gitea_api_key_release
      gitea-base-url: "" # 当`CI_FORGE_TYPE`为`gitea`且该值为空时，将尝试从环境变量`CI_FORGE_URL`获取
      # gitea-insecure: true # 允许不安全的Gitea连接
      gitea-dry-run: true # 启用干运行模式
      gitea-draft: true # 将发布标记为草稿
      gitea-prerelease: true # 将发布标记为预发布（默认值为true）
      # gitea-release-file-root-path: "" # 发布文件根路径，为空时使用工作区路径（通常为项目根路径）
      gitea-release-files-globs:
        - "doc/*.md"
      gitea-release-file-exists-do: "skip" # 发布文件已存在时的处理方式，支持：[fail overwrite skip]（默认："fail"）
      gitea-files-checksum: # 生成指定类型的校验和，为空时跳过，支持：[md5 sha1 sha256 sha512 adler32 crc32 blake2b blake2s]
        - "md5"
        - "sha256"
        - "sha512"
      gitea-release-title: "dry run release" # 发布标题，为空时使用标签名，可被规范变更日志的标签名覆盖
      # gitea-release-note-by-convention-change: true # 通过规范变更日志生成发布说明，若为true将读取变更日志文件并覆盖gitea-release-note设置 
      # gitea-release-read-change-log-file: CHANGELOG.md # 读取变更日志的文件路径，为空时使用默认CHANGELOG.md

注意事项

• Gitea客户端令牌需使用访问令牌

已知限制

• 干运行模式不会创建实际发布，仅打印发布信息
• 发布功能仅对tag事件可用