treas/github-release-resource

GitHub Releases Resource镜像

镜像概述

本镜像为Concourse CI的资源类型，用于与GitHub Releases进行交互，实现版本资源的获取与创建。通过该镜像，用户可在CI/CD流程中自动化检测GitHub仓库的版本更新、获取发布资产，以及创建新的Release并上传相关文件。

核心功能

1. check：检测GitHub仓库的已发布版本，按语义化版本（semver）排序，返回最新版本或指定版本后的更新。
2. in：从指定版本的Release中获取资产文件，并生成包含标签、版本、发布正文、提交SHA等元数据的文件。
3. out：根据指定的名称、标签和正文创建新的GitHub Release，并上传匹配指定glob模式的文件。

使用场景

• CI流程：代码合并后自动创建GitHub Release并上传构建产物（如二进制包、文档）。
• CD流程：获取指定版本的依赖包或配置文件，用于部署环境。
• 版本管理：定期检测GitHub仓库的版本更新，触发后续流程（如自动测试、部署）。

配置说明

源配置（Source Configuration）

• owner（必填）：GitHub仓库所属的用户或组织名称。
• repository（必填）：仓库名称。
• access_token（可选）：访问私有仓库或提高API请求限额的令牌，需具备repo或public_repo权限。
• github_api_url（可选）：非公开GitHub部署的API地址（如企业版GitHub）。
• github_uploads_url（可选）：文件上传的独立URL，若未设置则默认与github_api_url一致。
• insecure（可选，默认false）：允许与GitHub API建立不安全连接。
• release（可选，默认true）：是否检测和创建正式Release。
• pre_release（可选，默认false）：是否检测和创建预发布版本。
• drafts（可选，默认false）：是否检测和创建草稿版本。
• tag_filter（可选）：自定义标签过滤正则表达式，用于提取版本号。

示例配置

资源定义

yaml
- name: gh-release
  type: github-release
  source:
    owner: concourse
    repository: concourse
    access_token: abcdef1234567890

获取指定版本的Release资产

yaml
- get: gh-release
  version: { tag: 'v0.0.1' }

创建Release并上传文件

yaml
- put: gh-release
  params:
    name: path/to/release-name.txt
    tag: path/to/tag.txt
    body: path/to/release-body.md
    globs:
      - dist/*.tar.gz