Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

go generate a mermaid flowchart for org modules #11467

Merged
merged 1 commit into from
Dec 8, 2023
Merged

go generate a mermaid flowchart for org modules #11467

merged 1 commit into from
Dec 8, 2023

Conversation

jmank88
Copy link
Contributor

@jmank88 jmank88 commented Dec 2, 2023

This PR adds a script for generating a go module graph of the smartcontractkit org dependencies used to build chainlink.
The script is tools/bin/modgraph and can be invoked via make modgraph to regenerate go.md. This is wired in to go generate as well, so that the existing CI checks will ensure it stays up to date.
Screenshot from 2023-12-07 05-29-26

@jmank88 jmank88 requested a review from a team December 2, 2023 13:46
Copy link
Contributor

github-actions bot commented Dec 2, 2023

I see that you haven't updated any CHANGELOG files. Would it make sense to do so?

@jmank88 jmank88 force-pushed the modgraph branch 6 times, most recently from 49aaeab to 6e0337e Compare December 6, 2023 20:02
@jmank88 jmank88 marked this pull request as ready for review December 6, 2023 20:09
@cl-sonarqube-production
Copy link

SonarQube Quality Gate

Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@jmank88 jmank88 requested a review from a team December 7, 2023 11:31
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had a sort in here too, which produced a slightly better image, but which was not portable for some reason. My local standard ubuntu install treats / and - as interchangable, and so lists chainlink-vrf after chainlin/v2. CI standard ubuntu doesn't make this mistake. I just removed it so this wasn't blocked, but it would be nice to restore that behavior.

@jmank88 jmank88 added this pull request to the merge queue Dec 8, 2023
Merged via the queue into develop with commit 8b13213 Dec 8, 2023
74 checks passed
@jmank88 jmank88 deleted the modgraph branch December 8, 2023 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants