trunk-action 的安装和配置教程

项目基础介绍

trunk-action 是一个开源项目，它提供了一个GitHub Action，用于在代码提交到GitHub仓库时自动运行Trunk Code Quality，这是一个静态代码检查工具。它支持多种编程语言的代码质量检查、格式化以及代码安全问题的扫描。项目主要使用Go编程语言开发。

项目使用的关键技术和框架

本项目使用了以下关键技术和框架：

• Go：项目的主体语言，用于编写GitHub Action。
• GitHub Actions：GitHub提供的持续集成和持续部署服务。
• Trunk Code Quality：静态代码检查工具，支持多种编程语言的代码质量和安全检查。

项目安装和配置的准备工作

在开始安装和配置trunk-action之前，请确保您已经完成了以下准备工作：

1. 安装了Git。
2. 拥有GitHub账户并且已经创建了一个仓库。
3. 熟悉基本的GitHub操作，例如提交代码、创建分支等。

安装步骤

以下是将trunk-action添加到您的GitHub项目的步骤：

1. 创建一个新的GitHub仓库（如果您还没有的话）。

2. 添加GitHub Action文件： 在您的GitHub仓库中，创建一个名为.github/workflows/trunk-check.yaml的文件，用于定义工作流程。

3. 配置工作流程： 在.github/workflows/trunk-check.yaml文件中，添加以下内容：

   name: Pull Request
   
   on:
     pull_request:
   
   concurrency:
     group: ${{ github.head_ref || github.run_id }}
     cancel-in-progress: true
   
   permissions:
     read-all: true
     checks: write
   
   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
   

4. 提交工作流程文件： 将.github/workflows/trunk-check.yaml文件添加到您的仓库中，并提交到GitHub。

5. 创建一个.trunk目录（可选）： 如果您想要自定义Trunk Code Quality的行为，可以在您的项目根目录下创建一个.trunk目录，并在其中添加一个trunk.yaml文件来配置Trunk。

6. 推送更改： 将所有更改推送到您的GitHub仓库。

完成以上步骤后，每当有新的Pull Request创建或更新时，GitHub Actions就会自动运行trunk-action，检查代码质量，并在Pull Request中显示相关的注释和警告。