jenkinsci / ghprb-plugin

github pull requests builder plugin for Jenkins
https://plugins.jenkins.io/ghprb/
MIT License
507 stars 612 forks source link

Incorrect error message #765

Open cowlinator opened 4 years ago

cowlinator commented 4 years ago

The readme gives an example usage of CompareCoverageAction: [$class: 'CompareCoverageAction', scmVars: [GIT_URL: env.GIT_URL]]

The git url is passed to the function here. Looking at the source code, it seems that this argument is what is used to get the repo. The git url ( env.GIT_URL) is what is used.

So then, when it fails, why does the error message say that it is because of the 'GitHub project' field in job configuration?

java.io.IOException: Could not retrieve GitHub repository named {Organization}/{Repo} (Do you have properly set 'GitHub project' field in job configuration?)
19:36:04    at com.github.terma.jenkins.githubprcoveragestatus.GitHubPullRequestRepository.getGitHubRepository(GitHubPullRequestRepository.java:56)
19:36:04    at com.github.terma.jenkins.githubprcoveragestatus.CompareCoverageAction.perform(CompareCoverageAction.java:137)

This error is misleading and just incorrect.

Please fix the error message to state that the url may come from the argument, something a little more like:

java.io.IOException: Could not retrieve GitHub repository named {Organization}/{Repo} (Did you properly pass in the correct git url argument?)