gradle / gradle/github-dependency-graph-gradle-plugin

Error message on missing required input param prompts user to "Please report this issue"

Open
#134 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Groovy
Stars
95
Forks
18
Avg merge
21h 23m
Merged PRs (30d)
4

Description

When using the plugin without the correct environment variables set, the resulting exception looks like:

```
Caused by: org.gradle.api.GradleException: The GitHubDependencyGraphPlugin plugin encountered errors while writing the dependency snapshot json file.
Please report this issue at: https://github.com/gradle/github-dependency-graph-gradle-plugin/issues
at org.gradle.github.dependencygraph.internal.DependencyExtractor.close(DependencyExtractor.kt:271)
at org.gradle.api.services.internal.RegisteredBuildServiceProvider.lambda$maybeStop$1(RegisteredBuildServiceProvider.java:168)
... 132 more
Caused by: java.lang.IllegalStateException: The configuration parameter 'GITHUB_JOB_CORRELATOR' must be set: set an environment variable, or use '-DGITHUB_JOB_CORRELATOR=value' on the command-line.
```

Since this is a user configuration error, the exception should not prompt users to report an issue.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.