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

add module graph #1310

Merged
merged 2 commits into from
Nov 8, 2024
Merged

add module graph #1310

merged 2 commits into from
Nov 8, 2024

Conversation

jmank88
Copy link
Collaborator

@jmank88 jmank88 commented Nov 7, 2024

This PR adds a go.md with a mermaid flowchart of the org module graph for this repo, generated via https://github.com/jmank88/modgraph.

go install github.com/jmank88/[email protected]
./modgraph > go.md

This is based on the core version:

TODO

  • validate from CI

Below is a summarization created by an LLM (gpt-4-0125-preview). Be mindful of hallucinations and verify accuracy.

Why

The changes introduce a new GitHub Action workflow for generating module dependency graphs, automate the setup of Go environment for this purpose, and update Go module dependencies. Additionally, they refine the module path corrections in go.mod files to ensure accurate dependency management and introduce a visualization (go.md) for module dependencies specific to the project.

What

  • .github/workflows/modgraph.yaml
    Added GitHub Action workflow named Module graph that triggers on pull requests, sets up Go, checks out the repository, and generates a module dependency graph ensuring it does not introduce changes.
  • Makefile
    Introduced modgraph target that installs necessary tools and generates a module dependency visualization (go.md) using modgraph.
  • framework/examples/myproject/go.mod
    Updated module paths for chainlink-testing-framework dependencies to correct locations and updated Kubernetes (k8s.io) dependencies to v0.31.2.
  • framework/examples/myproject/go.sum
    Removed unused dependencies, reflecting cleanup and updates in go.mod.
  • framework/go.mod
    Added a new dependency (github.com/charmbracelet/huh/spinner) and updated indirect dependencies reflecting a refinement in project dependencies.
  • framework/go.sum
    Updated to reflect changes in go.mod, including the addition and removal of various dependencies.
  • go.md
    Added a new file to visualize the project's module dependencies in a structured format.
  • modgraph (script)
    Introduced a script to generate go.md, facilitating the visualization of module dependencies within the project.
  • tools/flakeguard/go.sum
    Updated to include a new checksum, possibly as a side effect of changes in the project's dependencies.

@jmank88 jmank88 requested review from kalverra and skudasov November 7, 2024 23:40
Copy link
Collaborator Author

@jmank88 jmank88 Nov 8, 2024

Choose a reason for hiding this comment

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

I suppose this could use a path filter on go.mod files? (and this file + modgraph)

@jmank88 jmank88 marked this pull request as ready for review November 8, 2024 13:33
@jmank88 jmank88 requested a review from sebawo as a code owner November 8, 2024 13:33
@jmank88 jmank88 requested a review from a team as a code owner November 8, 2024 13:33
@cl-sonarqube-production
Copy link

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

@jmank88 jmank88 merged commit cb1a5a5 into main Nov 8, 2024
47 of 49 checks passed
@jmank88 jmank88 deleted the modgraph branch November 8, 2024 23:02
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.

2 participants