tonglil/drone-github-comment

drone-github-comment 镜像文档

概述

drone-github-comment是一个Drone CI/CD系统的插件镜像，专门用于在GitHub上自动创建评论。它能够集成到Drone流水线中，在CI/CD流程的特定阶段自动向GitHub的Pull Request或Issue添加评论，实现自动化的反馈机制。

核心功能和特性

• 自动在GitHub Pull Request或Issue上创建评论
• 支持自定义评论内容，可包含CI/CD构建结果等动态信息
• 支持指定评论位置（特定PR或Issue）
• 轻量级设计，易于集成到现有Drone流水线
• 支持环境变量配置，便于传递敏感信息

使用场景和适用范围

• CI/CD流程结果通知：在构建完成后自动评论构建结果
• 代码质量报告：将代码质量检查结果以评论形式展示在PR上
• 自动化测试结果反馈：将测试覆盖率、测试结果等信息添加到PR评论
• 部署状态通知：在部署完成后评论部署状态和相关信息
• 适用于任何使用Drone CI/CD且需要与GitHub集成的开发团队

使用方法和配置说明

基本用法（Drone Pipeline配置）

yaml
steps:
  - name: github-comment
    image: tonglil/drone-github-comment
    settings:
      github_token:
        from_secret: github_token
      issue_number: 123
      body: "这是一条来自Drone CI的自动评论"

参数配置

必选参数

• github_token: GitHub访问令牌，需要有评论权限
• body: 评论内容

可选参数

• issue_number: 指定评论的Issue或PR编号
• repo: 目标GitHub仓库，格式为"owner/repo"，默认为当前仓库
• api_url: GitHub API地址，默认为"https://api.github.com"（适用于GitHub Enterprise用户可自定义）

环境变量配置

该插件支持通过环境变量传递配置：

• PLUGIN_GITHUB_TOKEN: 等同于github_token设置
• PLUGIN_ISSUE_NUMBER: 等同于issue_number设置
• PLUGIN_BODY: 等同于body设置
• PLUGIN_REPO: 等同于repo设置
• PLUGIN_API_URL: 等同于api_url设置

高级示例

在PR上评论测试覆盖率

yaml
steps:
  - name: test-coverage
    image: some-test-image
    commands:
      - run-tests --coverage > coverage.txt
      
  - name: comment-coverage
    image: tonglil/drone-github-comment
    settings:
      github_token:
        from_secret: github_token
      issue_number: ${DRONE_PULL_REQUEST}
      body: |
        测试覆盖率报告:
        ```
        $(cat coverage.txt)
        ```

使用自定义GitHub API地址（GitHub Enterprise）

yaml
steps:
  - name: github-comment
    image: tonglil/drone-github-comment
    settings:
      github_token:
        from_secret: github_token
      api_url: https://github.example.com/api/v3
      repo: my-org/my-repo
      issue_number: 456
      body: "这是来自企业GitHub的自动评论"

注意事项

• 确保GitHub令牌具有足够的权限（至少需要public_repo范围的访问权限）
• 在Drone中使用时，建议通过from_secret方式传递GitHub令牌，避免明文暴露
• 对于私有仓库，需要确保令牌具有相应的访问权限

相关链接

• https://github.com/tonglil/drone-github-comment
• Drone CI官方文档