GitHub 集成 - Tron CLI 文档

概述

Tron 可以无缝集成到 GitHub Actions 工作流中，实现自动化代码审查、PR 描述生成、Issue 处理等功能。通过将 Tron 嵌入 CI/CD 流程，团队可以在每次代码提交或 PR 创建时自动获得 AI 辅助的代码分析和文档生成。

无论是小型开源项目还是大型企业代码库，Tron 的 GitHub 集成都能帮助团队提高代码质量和开发效率。

PR 自动审查

使用 GitHub Actions 在每次 PR 创建或更新时自动触发 Tron 代码审查：

yaml

# .github/workflows/tron-review.yml
name: Tron PR Review

on:
  pull_request:
    types: [opened, synchronize, reopened]

jobs:
  review:
    runs-on: ubuntu-latest
    permissions:
      pull-requests: write
      contents: read

    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Install Tron CLI
        run: curl -fsSL https://upgrade.lianwo123.com/troncode/cli/install | bash

      - name: Run PR Review
        env:
          TRON_API_KEY: ${{ secrets.TRON_API_KEY }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          tron review --pr ${{ github.event.number }} \
            --repo ${{ github.repository }} \
            --comment

审查结果将以评论的形式自动发布到对应的 PR 页面，包含代码质量分析、潜在问题提示和改进建议。

PR 描述生成

利用管道将 Git diff 传入 Tron，自动生成专业的 PR 描述：

终端

git diff main | tron -p "生成 PR 描述，包含变更摘要、测试方案和影响范围"

在 GitHub Actions 中将生成的描述自动设置为 PR body：

yaml

name: Auto PR Description

on:
  pull_request:
    types: [opened]

jobs:
  describe:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Generate PR Description
        env:
          TRON_API_KEY: ${{ secrets.TRON_API_KEY }}
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          DESCRIPTION=$(git diff origin/main | tron -p "生成 PR 描述")
          gh pr edit ${{ github.event.number }} --body "$DESCRIPTION"

Issue 处理

自动对新建 Issue 进行分类并生成初步回复，帮助维护者快速响应用户反馈：

yaml

name: Issue Triage

on:
  issues:
    types: [opened]

jobs:
  triage:
    runs-on: ubuntu-latest
    steps:
      - name: Analyze and Label Issue
        env:
          TRON_API_KEY: ${{ secrets.TRON_API_KEY }}
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          ISSUE_BODY="${{ github.event.issue.body }}"
          LABEL=$(echo "$ISSUE_BODY" | tron -p "分析 Issue 类型，返回 bug/feature/question 之一")
          gh issue edit ${{ github.event.issue.number }} --add-label "$LABEL"

          REPLY=$(echo "$ISSUE_BODY" | tron -p "生成友好的 Issue 初步回复，说明团队会尽快处理")
          gh issue comment ${{ github.event.issue.number }} --body "$REPLY"

Commit 信息

在本地开发时，使用管道自动生成规范的 Commit 信息：

终端

git diff --staged | tron -p "生成符合 Conventional Commits 规范的 commit message"

feat(auth): add JWT token refresh logic

- Implement automatic token refresh before expiry

- Add retry logic for failed refresh attempts

- Update auth middleware to handle refresh flow

可以将此命令添加为 Git alias 或集成到 pre-commit hook 中，实现全自动化的 Commit 信息生成。

配置 Secrets

在 GitHub Actions 中使用 Tron 需要正确配置 API 密钥：

获取 Tron API 密钥

添加到 GitHub Secrets

进入 GitHub 仓库 → Settings → Secrets and variables → Actions，点击 "New repository secret"，名称填写 TRON_API_KEY，值粘贴你的 API 密钥。

在 Workflow 中引用

在 GitHub Actions workflow 文件中通过 ${{ secrets.TRON_API_KEY }} 引用密钥，传入环境变量 TRON_API_KEY。

yaml

env:
  TRON_API_KEY: ${{ secrets.TRON_API_KEY }}

🔒

安全提示

永远不要将 API 密钥直接写入 workflow 文件或提交到代码库中。始终通过 GitHub Secrets 管理敏感凭证。