From 4283247a19fafdcae648d70fb5872b7132e4ec99 Mon Sep 17 00:00:00 2001 From: Andy Coates <8012398+big-andy-coates@users.noreply.github.com> Date: Wed, 16 Aug 2023 18:47:25 +0100 Subject: [PATCH] Add example of using `DEPENDENCY_GRAPH_INCLUDE_PROJECTS` to docs (#844) Users will currently need to spend some time working out the required regex when using `DEPENDENCY_GRAPH_INCLUDE_PROJECTS`. Providing an example will get users up to speed quicker. Signed-off-by: Andy Coates <8012398+big-andy-coates@users.noreply.github.com> --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8806720..aac90a0 100644 --- a/README.md +++ b/README.md @@ -461,7 +461,8 @@ You can provide this value via the `DEPENDENCY_GRAPH_INCLUDE_PROJECTS` environme To restrict which Gradle configurations contribute to the report, you can filter configurations by name using a regular expression. You can provide this value via the `DEPENDENCY_GRAPH_INCLUDE_CONFIGURATIONS` environment variable or system property. -Example of a simple workflow that limits the dependency graph to `runtimeClasspath` configuration: +Example of a simple workflow that limits the dependency graph to `runtimeClasspath` configuration and to exclude `buildSrc` dependencies: + ```yaml name: Submit dependency graph on: @@ -480,7 +481,10 @@ jobs: with: dependency-graph: generate-and-submit - name: Run a build, generating the dependency graph from 'runtimeClasspath' configurations - run: ./gradlew build -DDEPENDENCY_GRAPH_INCLUDE_CONFIGURATIONS=runtimeClasspath + run: ./gradlew build + env: + DEPENDENCY_GRAPH_INCLUDE_CONFIGURATIONS: runtimeClasspath + DEPENDENCY_GRAPH_INCLUDE_PROJECTS: "^:(?!buildSrc).*" ``` ### Gradle version compatibility