n8n 工作流自动备份至 GitLab 并生成 AI 文档

触发器检测工作流变更 → 拉取 JSON → 检查 GitLab 仓库 → 创建或更新文件 → GPT-4.1 生成 README → 推送至仓库

给谁

使用 n8n 搭建自动化运维、需要版本控制工作流并自动生成文档的开发者或团队

你会得到

工作流更新或激活时，自动将工作流 JSON 备份到 GitLab，并生成对应的 README 文档

你需要

n8n · gitlab

步骤

1. 导入模板并配置凭证

   在 n8n 中导入模板 6731。进入各节点依次配置：GitLab 凭证（gitlabApi，需个人访问令牌）、n8n API 凭证（n8nApi，用于拉取工作流数据）、OpenAI 凭证（openAiApi，用于生成文档）。在 GitLab 节点中将 owner 和 repository 修改为你的实际仓库信息（默认 owner='n8n_projects'，repository='all_projects'）。

2. 设置触发器与获取工作流

   模板提供两种触发方式：n8n Trigger 节点（Workflow Change Detector）监听工作流的 update 和 activate 事件；Execute Workflow Trigger 节点（When Executed by Another Workflow）允许被其他工作流调用。触发后，Fetch Updated Workflow 节点通过 n8n API 获取完整工作流 JSON。

3. 检查 GitLab 仓库状态

   Check GitLab Repository 节点列出指定路径下的文件（设置 onError='continueRegularOutput' 以处理目录不存在的情况）。Analyze Repository State 节点执行代码判断：若返回错误且包含 'resource you are requesting could not be found'，或目录中不存在同名 .json 文件，则标记 isFileOnGit=false；否则标记为 true。

   运行提示词 · 来源原文。Analyze Repository State 节点的 JS Code 字段

   复制提示词

   // Loop over input items and add a new field called 'myNewField' to the JSON of each one
   const err = $input.first().json.error;
   if(err
      && err.indexOf("resource you are requesting could not be found")>0)
     return {workflow: $('Fetch Updated Workflow').first().json,isFileOnGit:false};
   
   let isFileOnGit = false;
   for (const item of $input.all()) {
     if(item.json.name == $('Fetch Updated Workflow').first().json.name +".json"){
       isFileOnGit = true;
       break;
     }
   }
   
   return {workflow: $('Fetch Updated Workflow').first().json,isFileOnGit};

4. 创建或更新工作流文件

   If 节点根据 isFileOnGit 分支：若文件已存在（true），走 Update Existing Workflow 节点，以 edit 操作更新同名 .json 文件；若不存在（false），走 Create New Workflow File 节点，以 create 操作新建文件。文件路径格式为 {workflow_name}/{workflow_name}.json，提交至 main 分支。

5. 生成 AI 文档并保存 README

   Create New Workflow File 完成后，Generate AI Documentation 节点调用 OpenAI GPT-4.1，传入工作流 JSON 并要求生成 README。输出必须为 JSON 格式 {"README":"markdown 内容"}。随后 Save README to GitLab 节点提取 message.content.README，保存为 {workflow_name}/readme.md。

   运行提示词 · 来源原文。Generate AI Documentation 节点的 messages.values[0].content 字段

   复制提示词

   =Generate a simple readme.md for the following n8n workflow json.
   Your json output must be exaclty this:
   {"README":"The markdown content"}
   Workflow JSON:
   
   {{ $('Analyze Repository State').item.json.workflow.toJsonString() }}

你正在复现 n8n 模板 6731：将工作流自动备份到 GitLab 并用 GPT-4.1 生成 README。请先确认你已具备 n8n 实例、GitLab 个人访问令牌（写入权限）和 OpenAI API 密钥。导入模板后，按步骤配置三种凭证，并修改 GitLab 节点的 owner 和 repository 为你的实际值。建议先用一个测试工作流触发 update 事件，验证 GitLab 中是否正确出现 JSON 和 readme.md 文件。