gradle-doctor icon indicating copy to clipboard operation
gradle-doctor copied to clipboard

Move/add extraMessage to root

Open deepy opened this issue 4 years ago • 2 comments

The doc for extra message sums this up very well.

    /**
     * Extra message text, if any, to show with the Gradle Doctor message. This is useful if you have a wiki page or
     * other instructions that you want to link for developers on your team if they encounter an issue.
     */

We have an internal wiki which we'd like to link to in each build to make it easier to direct developers to the right place. But we'd like to point to that in all messages, not only the ones related to JAVA_HOME

deepy avatar Mar 04 '21 11:03 deepy

@deepy good suggestion. The use case for the extra message was to point developers to the right solution specifically for the JAVA_HOME. Would the error message be customized based on the failure? That is, would you want to be able to set the error message differently for each type of failure? i.e. a wiki link for that specific failure? Or just a single message to add to all failure messages?

runningcode avatar Mar 06 '21 10:03 runningcode

Personally I'm going to link to a single wiki page with a table of content linking to all the cases, so a single one for each is more than enough

deepy avatar Mar 06 '21 12:03 deepy