Sync n8n Staging Workflows to GitHub PR for Merge

Sync n8n Staging Workflows to GitHub PRs for Merge

This n8n automation pulls a published workflow from your staging n8n, cleans the workflow JSON to keep diffs meaningful, commits it to GitHub on a new branch, and automatically opens a pull request so changes can be reviewed and merged like code.

What this workflow does

• Triggers when a workflow is activated/updated in n8n, or when another workflow calls it with a workflow_id input.
• Fetches workflow JSON from your staging n8n API using the provided workflow ID.
• Removes noisy metadata (e.g., IDs and timestamps) so GitHub diffs focus on real changes, then formats the cleaned JSON into a file payload.
• Creates/updates a GitHub branch: verifies the target repo, retrieves the base branch commit SHA, and creates a new branch named using the workflow name and version counter.
• Writes the workflow file: checks whether a JSON file already exists in the repository; then creates or updates it on the new branch by committing the base64-encoded JSON.
• Opens a GitHub Pull Request from the new branch into your configured base branch.

Use cases

• Promote workflow changes from staging n8n to production via a standard GitHub review + merge process.
• Ensure workflow JSON is source-controlled with clean diffs for safer collaboration among automation engineers.
• Support SaaS operations teams who need audit-friendly workflow versioning tied to PRs.

Technical details

• Integrations/Credentials: GitHub OAuth2 (repo scope) for GitHub API HTTP requests; n8n API credential for your staging instance using stagingN8nBaseUrl.
• Flow logic & nodes: if, set, code, merge, github, and an n8n trigger to drive the PR creation pipeline.