build.gradle
// build.gradle
plugins {
id 'net.siggijons.gradle.graphuntangler' version 0.0.4
}
See also: https://plugins.gradle.org/plugin/net.siggijons.gradle.graphuntangler
./gradlew analyzeModuleGraph
Does not play well with configuration cache and up-to-date checks appear to be off for the same
reason of not treating the Project
as an input.
Workaround is to run without configuration cache and re-run tasks
./gradlew analyzeModuleGraph --no-configuration-cache --rerun
./gradlew generateChangeFrequencyFile
This command assumes git is being used as SCV and will run git log
commands via bash to calculate the change frequency for each module in the project.
By default, the command looks at 28 days back from today. This behavior can be overwritten with properties:
./gradlew generateChangeFrequencyFile -Pfrequency-start=2021-12-10 -Pfrequency-days=14 --info
This will look at 14 days back from 2021-12-10.
Note: the task uses git log --follow --format=oneline --since=<date>
, so implicitly assumes that the current HEAD
is at frequency-start
for the lookback.
The idea is to use support something like this to look back in time:
# Analyze Graph like it was on 2021-12-13
git checkout `git rev-list -n 1 --before="2021-12-13 00:00" HEAD`
./gradlew generateChangeFrequencyFile -Pfrequency-start=2021-12-13 -Pfrequency-days=28
./gradlew analyzeModuleGraph
See GenerateChangeFrequencyTask
for more details.
Experimental
Module owner information can be included in analysis by providing an owners.yaml
file using the following format:
app:
team: App
modules:
- :app
- :feature:settings
feature:
team: Feature
modules:
- :feature:foryou
- :feature:interests
- :feature:bookmarks
- :feature:topic
core:
team: Core
modules:
- :core:common
- :core:data
- :core:data-test
- :core:database
- :core:datastore
- :core:datastore-test
- :core:designsystem
- :core:domain
- :core:model
- :core:network
- :core:ui
- :core:testing
- :core:analytics
- :sync:work
- :sync:sync-test
tools:
team: Tools
modules:
- :app-nia-catalog
- :benchmarks
- :lint
- :ui-test-hilt-manifest
All plugin outputs can be found in the build/untangler
directory.
File | Description |
---|---|
analyzeModuleGraph.txt |
Text based graph analysis output |
analyzeModuleGraph.csv |
CSV based graph analysis output |
analyzeModuleGraph.gv |
Full Dependency Graph |
analyzeModuleGraph-height.gv |
Dependency graph isolated to only include nodes that are part of the longest paths. |
analyzeModuleGraph-reduced.gv |
Transitively reduced graph. Removes information but can be helpful in understanding the structure of large dependency graphs. |
analyzeModuleGraph-reduced-owners.gv |
Transitively reduced graph. Colored by owners. Experimental. Only if owner data is available. |
analyzeModuleGraph-adjacencyMatrix.txt |
Adjacency Matrix that can be imported into other tools for further analysis. e.g. generating a co-occurrence matrix using pandas. |
isolated-subgraph-size.csv |
Index of the size of each isolated subgraph. This can be an indicator of how connected, or exposed, a module is to the graph. |
changeFrequency.txt |
CSV for the calculated change frequency of each module. |
projects/<module>-height.gv |
Height Graph for a module |
projects/<module>-isolated.gv |
Isolated Graph for a module. Created by removing all unconnected modules from the project graph. |
projects/<module>-isolated-reduced.gv |
Transitively reduced graph for a module. Removes information but can be helpful in understanding the structure of large dependency graphs. |
projects/<module>-descendants-owners.csv |
Experimental. Owners of all descendants of a module. Experimental. Only if owner data is available. |
projects/<module>-descendants-owners-count.csv |
Aggregation of descendants owner data. Experimental. Only if owner data is available. |
Graphs can be rendered using the dot
command from Graphviz
dot -Tpng build/untangler/analyzeModuleGraph-height.gv -o analyzeModuleGraph-height.png
Alternatively, the dependency graph can be imported into a tool such as Gephi for further analysis.
For development it's convenient to use inlcudeBuild
. To do so follow these steps:
Checkout this repository
Add to settings.gradle
includeBuild("/path/to/graph-untangler-plugin")
Add plugin to root build.gradle
// build.gradle
plugins {
id("net.siggijons.gradle.graphuntangler")
}