Quick overview
Eliminate architectural drift and outdated documentation during code reviews. This workflow extracts Mermaid diagrams and SQL schemas from GitHub Pull Requests, computes SHA-256 schema fingerprints, generates cryptographic trace UUIDs with DevDeskApp, and broadcasts visual diagram previews to Slack and Notion engineering wikis.
How it works
- Triggers either when you click “Test workflow” with a sample PR payload or when GitHub sends a pull_request event.
- Uses DevDeskApp to slugify the PR title, normalize the Mermaid text, and compute a SHA-256 fingerprint plus a UUID audit trace ID.
- Checks whether the PR payload contains Mermaid syntax to determine the documentation path.
- If Mermaid syntax is present, builds a Mermaid.ink image URL from the diagram text and formats a documentation payload with PR metadata and checksum.
- Posts the diagram preview and schema fingerprint to a Slack channel for architecture review.
- Creates a new page in a Notion database to archive the architecture diagram entry.
- If Mermaid syntax is missing, posts a Slack notice asking for an architecture diagram in the PR description.
Setup
- Connect GitHub OAuth2 credentials and set the repository/owner in the GitHub Trigger to match your repo.
- Install and configure the DevDeskApp n8n node/credentials so the text and crypto operations (slugify, hash, UUID) can run.
- Connect Slack credentials and update the target channel names/IDs for the architecture preview and missing-diagram notifications.
- Connect Notion credentials, set the target database ID, and map the page properties you want to write into the Notion “Create database page” step.