LintGuardian是一个n8n工作流模板，用于自动化GitHub仓库的代码质量强制执行。当创建拉取请求时，该工作流会自动分析更改的文件，识别代码风格问题，修复这些问题，并提交包含修正的新PR。这消除了手动代码风格审查，减少了来回评论，让您的团队专注于功能而非格式化。
工作原理
该工作流由GitHub webhook在创建PR时触发。它使用GitHub API获取PR中的所有更改文件，通过AI驱动的代码风格检查服务（Google Gemini）处理它们，并自动生成修复。AI代理然后创建一个包含修正文件的新分支，并针对原始分支提交”代码风格修复”PR。开发人员可以通过一次点击审查和合并这些修复，以最小的努力保持代码格式一致。
先决条件
要使用此模板，您需要：
n8n实例：自托管或使用n8n.cloud
GitHub仓库：您想要强制执行代码风格标准的仓库
GitHub个人访问令牌：具有仓库访问权限（repo、workflow、admin:repo_hook）
Google AI API密钥：用于支持代码风格分析的Gemini语言模型
GitHub webhook：配置为将PR创建事件发送到您的n8n实例
设置说明
将模板导入到您的n8n实例
配置凭据：
在凭据 → GitHub API下添加您的GitHub个人访问令牌
在凭据 → Google Gemini API下添加您的Google AI API密钥
更新仓库信息：
在工作流开头的”Set Common Fields”代码节点中定位
将gitHubRepoName和gitHubOrgName值更改为匹配您的仓库
const commonFields = {
‘gitHubRepoName’: ‘your-repo-name’,
‘gitHubOrgName’: ‘your-org-name’
}
配置webhook：
在您的仓库中创建一个名为.github/workflows/lint-guardian.yml的文件，将Trigger n8n Workflow步骤替换为您的webhook：
name: Lint Guardian
on:
pull_request:
types: [opened, synchronize]
jobs:
trigger-linting:
runs-on: ubuntu-latest
steps:
– name: Trigger n8n Workflow
uses: fjogeleit/http-request-action@v1
with:
url: ‘https://your-n8n-instance.com/webhook/1da5a6e1-9453-4a65-bbac-a1fed633f6ad’
method: ‘POST’
contentType: ‘application/json’
data: |
{
“pull_request_number”: ${{ github.event.pull_request.number }},
“repository”: “${{ github.repository }}”,
“branch”: “${{ github.event.pull_request.head.ref }}”,
“base_branch”: “${{ github.event.pull_request.base.ref }}”
}
preventFailureOnNoResponse: true
自定义代码风格规则（可选）：
修改AI代理的系统消息以指定您团队的代码风格偏好
如果您有特定的文件类型要关注或忽略，调整文件处理
安全考虑
创建GitHub个人访问令牌时，请记住：
选择所需的最小权限（repo、workflow、admin:repo_hook）
设置适当的过期日期
像对待密码一样对待您的令牌并安全存储
考虑使用GitHub的细粒度个人访问令牌以获得更有限的范围
如GitHub文档所述：”个人访问令牌类似于密码，它们共享相同的固有安全风险。”
扩展模板
您可以通过以下方式增强此工作流：
在提交代码风格修复时添加Slack通知
创建特定于您团队需求的自定义代码风格规则
扩展它以处理不同类型的代码质量检查
为更受控的环境添加批准步骤
此模板提供了一个优秀的起点，您可以自定义以适应您团队的确切工作流和代码风格要求。
评论(0)