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

Update module dependency graphs and add script to create them #1257

Merged
merged 5 commits into from
Mar 14, 2024

Conversation

dturner
Copy link
Collaborator

@dturner dturner commented Mar 7, 2024

What I have done and why

  • Added new module dependency graphs for each module (displayed in README.md for each module) so it's easy to visualise module dependencies
  • Created a script to regenerate module dependency graphs so it's easier to keep them up to date

To run the script, execute the following command in the project's root folder:

./generateModuleGraphs.sh --exclude-module :benchmarks --exclude-module :lint --exclude-module :ui-test-hilt-manifest

The --exclude-module parameter is used to exclude modules which don't appear in the root dependency graph (orphaned modules, only used by external programs, like CI or Android Studio)

Related issues/PRs:
#1088
#707

Future work

  • Decide whether this should be integrated into CI, similar to screenshot tests and badging

Nice to haves:

  • Add URLs to the images either to navigate between module graphs. Requires adding URLs for each node in the graph, which would be better done by modifying the plugin here, rather than hacking around with the .gv file it creates.
  • Default size of SVGs seems quite small. Tried using dot -s for scaling but didn't work.

Change-Id: I7b2ae264ec84491c847a44869934e2f238564c31
@dturner dturner marked this pull request as draft March 7, 2024 00:24
dturner added 2 commits March 7, 2024 14:05
Change-Id: Ibec84b6b58d8e7911057da046bbebddcc32ceb01
Change-Id: I611f73d59790bde240756e8016aa721a1783335f
@dturner dturner marked this pull request as ready for review March 7, 2024 15:32
@dturner dturner requested a review from JoseAlcerreca March 11, 2024 18:02
@dturner dturner self-assigned this Mar 11, 2024
@dturner dturner requested review from alexvanyo and jdkoren March 11, 2024 18:03
Copy link
Contributor

@jdkoren jdkoren left a comment

Choose a reason for hiding this comment

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

LGTM overall

generateModuleGraphs.sh Outdated Show resolved Hide resolved
generateModuleGraphs.sh Outdated Show resolved Hide resolved
Change-Id: I9c825c142799cdbb99890d49ded067427cf9fee8
Change-Id: Ifb4b44e67df53ddd8ed048122c6c12a904e61528
@ghost ghost mentioned this pull request Sep 29, 2024
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