Auto Backup n8n Workflows to GitLab with AI-Generated Documentation

Trigger detects workflow changes → fetch JSON → check GitLab repo → create or update file → GPT-4.1 generates README → push to repository

Who

Developers or teams using n8n for automation ops who need version-controlled workflows with auto-generated docs

You get

When a workflow is updated or activated, automatically back up its JSON to GitLab and generate a matching README

You need

n8n · gitlab

Steps

1. Import template and configure credentials

   Import template 6731 in n8n. Configure credentials in each node: GitLab (gitlabApi, needs personal access token), n8n API (n8nApi, for fetching workflow data), and OpenAI (openAiApi, for documentation generation). Update the owner and repository fields in GitLab nodes to match your setup (defaults: owner='n8n_projects', repository='all_projects').

2. Set triggers and fetch workflow data

   The template provides two triggers: the n8n Trigger node (Workflow Change Detector) listens for workflow update and activate events; the Execute Workflow Trigger node (When Executed by Another Workflow) allows being called by other workflows. Upon trigger, the Fetch Updated Workflow node retrieves the full workflow JSON via the n8n API.

3. Check GitLab repository state

   The Check GitLab Repository node lists files at the specified path (with onError='continueRegularOutput' to handle non-existent directories). The Analyze Repository State node runs code to determine: if the error contains 'resource you are requesting could not be found', or if no matching .json file exists, mark isFileOnGit=false; otherwise mark true.

   Execution prompt · Source text。JS Code field of the Analyze Repository State node

   Copy prompt

   // 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. Create or update workflow file

   The If node branches on isFileOnGit: if true, route to Update Existing Workflow to edit the existing .json file; if false, route to Create New Workflow File to create it. File path format is {workflow_name}/{workflow_name}.json, committed to the main branch.

5. Generate AI documentation and save README

   After creating the workflow file, the Generate AI Documentation node calls OpenAI GPT-4.1 with the workflow JSON and requests a README. Output must be strict JSON: {"README":"markdown content"}. The Save README to GitLab node then extracts message.content.README and saves it as {workflow_name}/readme.md.

   Execution prompt · Source text。messages.values[0].content field of the Generate AI Documentation node

   Copy prompt

   =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() }}

You are recreating n8n template 6731: auto-backup workflows to GitLab with GPT-4.1-generated READMEs. First confirm you have an n8n instance, a GitLab personal access token (write access), and an OpenAI API key. After importing the template, configure the three credential types and update the GitLab node's owner and repository to your actual values. Test by triggering an update on a dummy workflow and verify both JSON and readme.md appear in GitLab.