Trunk.io GitHub Action 开源项目最佳实践

1. 项目介绍

Trunk.io GitHub Action 是一个开源项目，它提供了一种自动化代码质量检查的方式。通过集成到 GitHub Actions 中，它可以在代码提交或拉取请求（Pull Request）时自动运行 Trunk Code Quality，对代码进行静态分析，包括格式化、语法检查、安全风险扫描等，帮助开发者及时发现和修复代码问题。

2. 项目快速启动

以下是快速启动 Trunk.io GitHub Action 的步骤：

首先，在你的 GitHub 仓库中创建一个新的工作流文件，通常位于 .github/workflows/ 目录下。例如，创建一个名为 trunk-check.yaml 的文件。

name: Pull Request

on:
  pull_request:

concurrency:
  group: ${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

permissions:
  checks: write
  contents: read

jobs:
  trunk_check:
    name: Trunk Code Quality Runner
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Trunk Code Quality
        uses: trunk-io/trunk-action@v1

保存这个文件后，每次有新的拉取请求创建或更新时，GitHub Actions 将自动执行这个工作流。

3. 应用案例和最佳实践

案例一：集成到现有的 CI/CD 流程

在你的 CI/CD 流程中加入 Trunk.io GitHub Action，可以在代码合并到主分支前自动检查代码质量。

jobs:
  build-and-check:
    name: Build and Check Code Quality
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Build
        run: | 
          # 你的构建命令
      - name: Check Code Quality
        uses: trunk-io/trunk-action@v1

案例二：自定义代码质量检查

如果你已经有特定的代码质量检查工具（如 ESLint），可以通过自定义设置来集成到 Trunk.io 中。

jobs:
  custom-check:
    name: Custom Code Quality Check
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Install Dependencies
        run: |
          npm install
      - name: Enable ESLint
        run: |
          trunk check enable eslint
      - name: Trunk Code Quality
        uses: trunk-io/trunk-action@v1

4. 典型生态项目

Trunk.io GitHub Action 可以与多种开源项目集成，以下是一些典型的生态项目：

• 前端项目：使用 Trunk.io 来检查 JavaScript、CSS 和 HTML 文件的格式和错误。
• 后端项目：在 Python、Java 或其他后端语言项目中集成 Trunk.io，以确保代码质量符合标准。
• 全栈项目：对于包含前后端代码的项目，Trunk.io 可以提供全面的代码质量检查。
• 移动应用项目：对于 iOS 或 Android 项目，Trunk.io 可以帮助检查 Swift 或 Kotlin 代码的质量。

通过以上最佳实践，你可以有效地使用 Trunk.io GitHub Action 来提升代码质量，并确保项目持续遵循最佳编码实践。