add module graph (#1232)

Author: jmank88

.github/workflows/codegen.yml

@@ -25,20 +25,19 @@ jobs:
           go-version: ${{ env.GO_VERSION }}
       - name: Display Go version
         run: go version
+      - name: Tidy
+        run: make gomodtidy
       - name: Install protoc
         run: make install-protoc
       - name: Re-Generate files
-        run: |
-          make generate
-      - name: Tidy
-        run: go mod tidy
+        run: make generate
       - name: ensure no changes
         run: |
           set -e
           git_status=$(git status --porcelain=v1)
           if [ ! -z "$git_status" ]; then
             git status
             git diff
-            echo "Error: modified files detected, run 'make generate' / 'go mod tidy'."
+            echo "Error: modified files detected, run 'make gomodtidy' / 'make generate' / ."
             exit 1
           fi

Makefile

@@ -23,7 +23,7 @@ build: ensure_go_version
 
 # If you have a different version of protoc installed, you can use the following command to generate the protobuf files
 # make generate PROTOC_BIN=/path/to/protoc
-generate: ensure_go_version clean-generate proto-generate generate-mocks
+generate: ensure_go_version clean-generate proto-generate generate-mocks modgraph
 
 generate-mocks: ensure_go_version
 	go install github.com/vektra/mockery/[email protected]
@@ -104,3 +104,13 @@ install_buf:
 
 ensure_buf_version:
 	@$(BUF_BIN) --version | grep -q '1.50.0' || (echo "Please use buf 1.50.0" && exit 1)
+
+gomods: ## Install gomods
+	go install github.com/jmank88/[email protected]
+
+gomodtidy: gomods
+	gomods tidy
+
+modgraph: gomods
+	go install github.com/jmank88/[email protected]
+	./modgraph > go.md

chains/solana/Makefile

@@ -17,7 +17,7 @@ clippy:
 
 .PHONY: gomods
 gomods: ## Install gomods
-	go install github.com/jmank88/[email protected].3
+	go install github.com/jmank88/[email protected].7
 
 .PHONY: gomodtidy
 gomodtidy: gomods

go.md

@@ -0,0 +1,177 @@
+# smartcontractkit Go modules
+## Main module
+```mermaid
+flowchart LR
+
+	chain-selectors
+	click chain-selectors href "https://github.com/smartcontractkit/chain-selectors"
+	chainlink-ccip --> chainlink-common
+	chainlink-ccip --> chainlink-protos/rmn/v1.6/go
+	click chainlink-ccip href "https://github.com/smartcontractkit/chainlink-ccip"
+	chainlink-common --> chain-selectors
+	chainlink-common --> chainlink-common/pkg/chipingress
+	chainlink-common --> chainlink-protos/billing/go
+	chainlink-common --> chainlink-protos/cre/go
+	chainlink-common --> chainlink-protos/storage-service
+	chainlink-common --> chainlink-protos/workflows/go
+	chainlink-common --> freeport
+	chainlink-common --> grpc-proxy
+	chainlink-common --> libocr
+	click chainlink-common href "https://github.com/smartcontractkit/chainlink-common"
+	chainlink-common/pkg/chipingress
+	click chainlink-common/pkg/chipingress href "https://github.com/smartcontractkit/chainlink-common"
+	chainlink-protos/billing/go
+	click chainlink-protos/billing/go href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-protos/cre/go
+	click chainlink-protos/cre/go href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-protos/rmn/v1.6/go
+	click chainlink-protos/rmn/v1.6/go href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-protos/storage-service
+	click chainlink-protos/storage-service href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-protos/workflows/go
+	click chainlink-protos/workflows/go href "https://github.com/smartcontractkit/chainlink-protos"
+	freeport
+	click freeport href "https://github.com/smartcontractkit/freeport"
+	grpc-proxy
+	click grpc-proxy href "https://github.com/smartcontractkit/grpc-proxy"
+	libocr
+	click libocr href "https://github.com/smartcontractkit/libocr"
+
+	subgraph chainlink-common-repo[chainlink-common]
+		 chainlink-common
+		 chainlink-common/pkg/chipingress
+	end
+	click chainlink-common-repo href "https://github.com/smartcontractkit/chainlink-common"
+
+	subgraph chainlink-protos-repo[chainlink-protos]
+		 chainlink-protos/billing/go
+		 chainlink-protos/cre/go
+		 chainlink-protos/rmn/v1.6/go
+		 chainlink-protos/storage-service
+		 chainlink-protos/workflows/go
+	end
+	click chainlink-protos-repo href "https://github.com/smartcontractkit/chainlink-protos"
+
+	classDef outline stroke-dasharray:6,fill:none;
+	class chainlink-common-repo,chainlink-protos-repo outline
+```
+## All modules
+```mermaid
+flowchart LR
+
+	ccip-owner-contracts
+	click ccip-owner-contracts href "https://github.com/smartcontractkit/ccip-owner-contracts"
+	chain-selectors
+	click chain-selectors href "https://github.com/smartcontractkit/chain-selectors"
+	chainlink-aptos --> chainlink-common
+	click chainlink-aptos href "https://github.com/smartcontractkit/chainlink-aptos"
+	chainlink-ccip --> chainlink-common
+	chainlink-ccip --> chainlink-protos/rmn/v1.6/go
+	click chainlink-ccip href "https://github.com/smartcontractkit/chainlink-ccip"
+	chainlink-ccip/chains/evm/deployment --> chainlink-ccip/deployment
+	chainlink-ccip/chains/evm/deployment --> chainlink-evm/gethwrappers
+	click chainlink-ccip/chains/evm/deployment href "https://github.com/smartcontractkit/chainlink-ccip"
+	chainlink-ccip/chains/solana --> chainlink-ccip
+	chainlink-ccip/chains/solana --> chainlink-ccip/chains/solana/gobindings
+	click chainlink-ccip/chains/solana href "https://github.com/smartcontractkit/chainlink-ccip"
+	chainlink-ccip/chains/solana/deployment --> chainlink-ccip/deployment
+	click chainlink-ccip/chains/solana/deployment href "https://github.com/smartcontractkit/chainlink-ccip"
+	chainlink-ccip/chains/solana/gobindings
+	click chainlink-ccip/chains/solana/gobindings href "https://github.com/smartcontractkit/chainlink-ccip"
+	chainlink-ccip/cmd/carpenter --> chainlink-ccip
+	click chainlink-ccip/cmd/carpenter href "https://github.com/smartcontractkit/chainlink-ccip"
+	chainlink-ccip/deployment --> chainlink-deployments-framework
+	click chainlink-ccip/deployment href "https://github.com/smartcontractkit/chainlink-ccip"
+	chainlink-common --> chain-selectors
+	chainlink-common --> chainlink-common/pkg/chipingress
+	chainlink-common --> chainlink-protos/billing/go
+	chainlink-common --> chainlink-protos/cre/go
+	chainlink-common --> chainlink-protos/storage-service
+	chainlink-common --> chainlink-protos/workflows/go
+	chainlink-common --> freeport
+	chainlink-common --> grpc-proxy
+	chainlink-common --> libocr
+	click chainlink-common href "https://github.com/smartcontractkit/chainlink-common"
+	chainlink-common/pkg/chipingress
+	click chainlink-common/pkg/chipingress href "https://github.com/smartcontractkit/chainlink-common"
+	chainlink-common/pkg/values
+	click chainlink-common/pkg/values href "https://github.com/smartcontractkit/chainlink-common"
+	chainlink-deployments-framework --> ccip-owner-contracts
+	chainlink-deployments-framework --> chainlink-protos/chainlink-catalog
+	chainlink-deployments-framework --> chainlink-protos/job-distributor
+	chainlink-deployments-framework --> chainlink-testing-framework/seth
+	chainlink-deployments-framework --> chainlink-tron/relayer
+	chainlink-deployments-framework --> mcms
+	click chainlink-deployments-framework href "https://github.com/smartcontractkit/chainlink-deployments-framework"
+	chainlink-evm/gethwrappers
+	click chainlink-evm/gethwrappers href "https://github.com/smartcontractkit/chainlink-evm"
+	chainlink-protos/billing/go
+	click chainlink-protos/billing/go href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-protos/chainlink-catalog
+	click chainlink-protos/chainlink-catalog href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-protos/cre/go
+	click chainlink-protos/cre/go href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-protos/job-distributor
+	click chainlink-protos/job-distributor href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-protos/rmn/v1.6/go
+	click chainlink-protos/rmn/v1.6/go href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-protos/storage-service
+	click chainlink-protos/storage-service href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-protos/workflows/go
+	click chainlink-protos/workflows/go href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-testing-framework/framework
+	click chainlink-testing-framework/framework href "https://github.com/smartcontractkit/chainlink-testing-framework"
+	chainlink-testing-framework/seth
+	click chainlink-testing-framework/seth href "https://github.com/smartcontractkit/chainlink-testing-framework"
+	chainlink-tron/relayer --> chainlink-common
+	chainlink-tron/relayer --> chainlink-common/pkg/values
+	click chainlink-tron/relayer href "https://github.com/smartcontractkit/chainlink-tron"
+	freeport
+	click freeport href "https://github.com/smartcontractkit/freeport"
+	grpc-proxy
+	click grpc-proxy href "https://github.com/smartcontractkit/grpc-proxy"
+	libocr
+	click libocr href "https://github.com/smartcontractkit/libocr"
+	mcms --> chainlink-aptos
+	mcms --> chainlink-ccip/chains/solana
+	mcms --> chainlink-testing-framework/framework
+	click mcms href "https://github.com/smartcontractkit/mcms"
+
+	subgraph chainlink-ccip-repo[chainlink-ccip]
+		 chainlink-ccip
+		 chainlink-ccip/chains/evm/deployment
+		 chainlink-ccip/chains/solana
+		 chainlink-ccip/chains/solana/deployment
+		 chainlink-ccip/chains/solana/gobindings
+		 chainlink-ccip/cmd/carpenter
+		 chainlink-ccip/deployment
+	end
+	click chainlink-ccip-repo href "https://github.com/smartcontractkit/chainlink-ccip"
+
+	subgraph chainlink-common-repo[chainlink-common]
+		 chainlink-common
+		 chainlink-common/pkg/chipingress
+		 chainlink-common/pkg/values
+	end
+	click chainlink-common-repo href "https://github.com/smartcontractkit/chainlink-common"
+
+	subgraph chainlink-protos-repo[chainlink-protos]
+		 chainlink-protos/billing/go
+		 chainlink-protos/chainlink-catalog
+		 chainlink-protos/cre/go
+		 chainlink-protos/job-distributor
+		 chainlink-protos/rmn/v1.6/go
+		 chainlink-protos/storage-service
+		 chainlink-protos/workflows/go
+	end
+	click chainlink-protos-repo href "https://github.com/smartcontractkit/chainlink-protos"
+
+	subgraph chainlink-testing-framework-repo[chainlink-testing-framework]
+		 chainlink-testing-framework/framework
+		 chainlink-testing-framework/seth
+	end
+	click chainlink-testing-framework-repo href "https://github.com/smartcontractkit/chainlink-testing-framework"
+
+	classDef outline stroke-dasharray:6,fill:none;
+	class chainlink-ccip-repo,chainlink-common-repo,chainlink-protos-repo,chainlink-testing-framework-repo outline
+```

modgraph

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+# Generates go.md
+
+set -e
+
+echo "# smartcontractkit Go modules
+## Main module
+\`\`\`mermaid
+flowchart LR
+"
+go mod graph | modgraph -prefix github.com/smartcontractkit/
+echo "\`\`\`"
+
+echo "## All modules
+\`\`\`mermaid
+flowchart LR
+"
+gomods graph | modgraph -prefix github.com/smartcontractkit/
+echo "\`\`\`"