From 8b13213bfbbe855fc1ffadf82301b47b4ec1b00b Mon Sep 17 00:00:00 2001
From: Jordan Krage <jmank88@gmail.com>
Date: Fri, 8 Dec 2023 06:53:40 -0600
Subject: [PATCH] go generate a mermaid flowchart for org modules (#11467)

---
 GNUmakefile        |  4 +++
 go.md              | 65 ++++++++++++++++++++++++++++++++++++++++++++++
 main.go            |  1 +
 tools/bin/modgraph | 46 ++++++++++++++++++++++++++++++++
 4 files changed, 116 insertions(+)
 create mode 100644 go.md
 create mode 100755 tools/bin/modgraph

diff --git a/GNUmakefile b/GNUmakefile
index 7d0753911a3..09b1dfe87a3 100644
--- a/GNUmakefile
+++ b/GNUmakefile
@@ -147,6 +147,10 @@ goreleaser-dev-build: ## Run goreleaser snapshot build
 goreleaser-dev-release: ## run goreleaser snapshot release
 	./tools/bin/goreleaser_wrapper release --snapshot --rm-dist --config ${GORELEASER_CONFIG}
 
+.PHONY: modgraph
+modgraph:
+	./tools/bin/modgraph > go.md
+
 help:
 	@echo ""
 	@echo "         .__           .__       .__  .__        __"
diff --git a/go.md b/go.md
new file mode 100644
index 00000000000..090221a89fd
--- /dev/null
+++ b/go.md
@@ -0,0 +1,65 @@
+# smartcontractkit Go modules
+```mermaid
+flowchart LR
+  subgraph chains
+    chainlink-cosmos
+    chainlink-evm
+    chainlink-solana
+    chainlink-starknet/relayer
+  end
+
+  subgraph products
+    chainlink-automation
+    chainlink-ccip
+    chainlink-data-streams
+    chainlink-feeds
+    chainlink-functions
+    chainlink-vrf
+  end
+
+  classDef outline stroke-dasharray:6,fill:none;
+  class chains,products outline
+
+  chainlink/v2 --> caigo
+  click caigo href "https://github.com/smartcontractkit/caigo"
+  chainlink/v2 --> chainlink-automation
+  click chainlink-automation href "https://github.com/smartcontractkit/chainlink-automation"
+  chainlink/v2 --> chainlink-common
+  click chainlink-common href "https://github.com/smartcontractkit/chainlink-common"
+  chainlink/v2 --> chainlink-cosmos
+  click chainlink-cosmos href "https://github.com/smartcontractkit/chainlink-cosmos"
+  chainlink/v2 --> chainlink-data-streams
+  click chainlink-data-streams href "https://github.com/smartcontractkit/chainlink-data-streams"
+  chainlink/v2 --> chainlink-feeds
+  click chainlink-feeds href "https://github.com/smartcontractkit/chainlink-feeds"
+  chainlink/v2 --> chainlink-solana
+  click chainlink-solana href "https://github.com/smartcontractkit/chainlink-solana"
+  chainlink/v2 --> chainlink-starknet/relayer
+  click chainlink-starknet/relayer href "https://github.com/smartcontractkit/chainlink-starknet"
+  chainlink/v2 --> chainlink-vrf
+  click chainlink-vrf href "https://github.com/smartcontractkit/chainlink-vrf"
+  chainlink/v2 --> libocr
+  click libocr href "https://github.com/smartcontractkit/libocr"
+  chainlink/v2 --> tdh2/go/ocr2/decryptionplugin
+  click tdh2/go/ocr2/decryptionplugin href "https://github.com/smartcontractkit/tdh2"
+  chainlink/v2 --> tdh2/go/tdh2
+  click tdh2/go/tdh2 href "https://github.com/smartcontractkit/tdh2"
+  chainlink/v2 --> wsrpc
+  click wsrpc href "https://github.com/smartcontractkit/wsrpc"
+  chainlink-automation --> libocr
+  chainlink-common --> libocr
+  chainlink-cosmos --> chainlink-common
+  chainlink-cosmos --> libocr
+  chainlink-data-streams --> chainlink-common
+  chainlink-data-streams --> libocr
+  chainlink-feeds --> chainlink-common
+  chainlink-feeds --> libocr
+  chainlink-solana --> chainlink-common
+  chainlink-solana --> libocr
+  chainlink-starknet/relayer --> caigo
+  chainlink-starknet/relayer --> chainlink-common
+  chainlink-starknet/relayer --> libocr
+  chainlink-vrf --> libocr
+  tdh2/go/ocr2/decryptionplugin --> libocr
+  tdh2/go/ocr2/decryptionplugin --> tdh2/go/tdh2
+```
diff --git a/main.go b/main.go
index 2a224c96d29..7e262f85f28 100644
--- a/main.go
+++ b/main.go
@@ -6,6 +6,7 @@ import (
 	"github.com/smartcontractkit/chainlink/v2/core"
 )
 
+//go:generate make modgraph
 func main() {
 	os.Exit(core.Main())
 }
diff --git a/tools/bin/modgraph b/tools/bin/modgraph
new file mode 100755
index 00000000000..b61264cb021
--- /dev/null
+++ b/tools/bin/modgraph
@@ -0,0 +1,46 @@
+#!/usr/bin/env bash
+
+# Generates go.md
+
+set -e
+
+echo "# smartcontractkit Go modules
+\`\`\`mermaid
+flowchart LR
+  subgraph chains
+    chainlink-cosmos
+    chainlink-evm
+    chainlink-solana
+    chainlink-starknet/relayer
+  end
+
+  subgraph products
+    chainlink-automation
+    chainlink-ccip
+    chainlink-data-streams
+    chainlink-feeds
+    chainlink-functions
+    chainlink-vrf
+  end
+
+  classDef outline stroke-dasharray:6,fill:none;
+  class chains,products outline
+"
+go mod graph | \
+  # org only
+  grep smartcontractkit.*smartcontractkit | \
+  # drop prefix
+  sed s/"github\.com\/smartcontractkit\/"/""/g | \
+  # insert edges
+  sed s/" "/" --> "/ | \
+  # drop versions
+  sed s/"@[^ ]*"/""/g | \
+  # insert links
+  sed s/"\([^ ]*\)$"/"\1\nclick \1 href \"https:\/\/github.com\/smartcontractkit\/\1\""/ | \
+  # truncate links to repo
+  sed s/"\"https:\/\/github.com\/smartcontractkit\/\([^\"\/]*\)\/.*\""/"\"https:\/\/github.com\/smartcontractkit\/\1\""/ | \
+  # dedupe lines
+  awk '!x[$0]++' | \
+  # indent
+  sed 's/^/  /'
+echo "\`\`\`"
\ No newline at end of file