Add example of using DEPENDENCY_GRAPH_INCLUDE_PROJECTS to docs

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>
This commit is contained in:
Andy Coates 2023-08-16 14:14:20 +01:00 committed by GitHub
parent e3028deccc
commit f2d3d1db9a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -461,7 +461,7 @@ 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:
@ -481,6 +481,8 @@ jobs:
dependency-graph: generate-and-submit
- name: Run a build, generating the dependency graph from 'RuntimeClasspath' configurations
run: ./gradlew build -DDEPENDENCY_GRAPH_INCLUDE_CONFIGURATIONS=RuntimeClasspath
env:
DEPENDENCY_GRAPH_INCLUDE_PROJECTS: "^:(?!buildSrc).*"
```
### Gradle version compatibility