[JIRA] (JENKINS-38479) Grade Plugin: Fix Documentation of the "Root Build script" attribute

serosset@cisco.com (JIRA)

unread,

Sep 23, 2016, 10:59:02 PM9/23/16

to jenkinsc...@googlegroups.com

Sebastien Rosset created an issue

Jenkins /

JENKINS-38479

Grade Plugin: Fix Documentation of the "Root Build script" attribute

Issue Type:	Bug
Assignee:	wolfs
Components:	gradle-plugin
Created:	2016/Sep/24 2:58 AM
Environment:	Jenkins ver. 1.642.18.3 (CloudBees Jenkins Enterprise 15.11) Gradle Plugin Chrome Web browser
Priority:	Minor
Reporter:	Sebastien Rosset

The Gradle plugin has the following documentation for the "Root Build script" attribute:

If your workspace has the top-level build.gradle in somewhere other than the module root directory, specify the path (relative to the module root) here, such as *$

{workspace}/parent/ *instead of just ${workspace}

. If left empty, defaults to build.gradle

The doc is confusing because:
1) The doc states the path is relative to the module root, but at the same time it provides an example with an absolute path - assuming $

{workspace} is expanded to an absolute path.
2) The doc provides ${workspace}

as an example, is this referring to the WORKSPACE environment variable? Then shouldn't it be all caps?
3) It's not clear if the user is supposed to enter a directory name or a file name. The documentation has an example with $

{workspace}

/parent/ which is a directory, but the doc also states the default is build.gradle, which is a file.

Add Comment

This message was sent by Atlassian JIRA (v7.1.7#71011-sha1:2526d7c)

serosset@cisco.com (JIRA)

unread,

Sep 23, 2016, 10:59:03 PM9/23/16

to jenkinsc...@googlegroups.com

Sebastien Rosset updated an issue

Jenkins /

JENKINS-38479

Grade Plugin: Fix Documentation of the "Root Build script" attribute

Change By:	Sebastien Rosset

The Gradle plugin has the following documentation for the "Root Build script" attribute:

{{ If your workspace has the top-level build.gradle in somewhere other than the module root directory, specify the path (relative to the module root) here, such as ${workspace}/parent/ instead of just ${workspace}. If left empty, defaults to build.gradle }}

The doc is confusing because:
1) The doc states the path is relative to the module root, but at the same time it provides an example with an absolute path - assuming ${workspace} is expanded to an absolute path.
2) The doc provides ${workspace} as an example, is this referring to the WORKSPACE environment variable? Then shouldn't it be all caps?
3) It's not clear if the user is supposed to enter a directory name or a file name. The documentation has an example with ${workspace}/parent/ which is a directory, but the doc also states the default is build.gradle, which is a file.

Add Comment

serosset@cisco.com (JIRA)

unread,

Sep 23, 2016, 10:59:03 PM9/23/16

to jenkinsc...@googlegroups.com

Sebastien Rosset updated an issue

Jenkins /

JENKINS-38479

Grade Plugin: Fix Documentation of the "Root Build script" attribute

Change By:	Sebastien Rosset

The Gradle plugin has the following documentation for the "Root Build script" attribute:

If your workspace has the top-level build.gradle in somewhere other than the module root directory, specify the path (relative to the module root) here, such as * ${workspace}/parent/ * instead of just ${workspace}. If left empty, * defaults to build.gradle *

The doc is confusing because:
1) The doc states the path is relative to the module root, but at the same time it provides an example with an absolute path - assuming ${workspace} is expanded to an absolute path.
2) The doc provides ${workspace} as an example, is this referring to the WORKSPACE environment variable? Then shouldn't it be all caps?
3) It's not clear if the user is supposed to enter a directory name or a file name. The documentation has an example with ${workspace}/parent/ which is a directory, but the doc also states the default is build.gradle, which is a file.

Add Comment

serosset@cisco.com (JIRA)

unread,

Sep 23, 2016, 11:00:02 PM9/23/16

to jenkinsc...@googlegroups.com

Sebastien Rosset updated an issue

Jenkins /

JENKINS-38479

Grade Plugin: Fix Documentation of the "Root Build script" attribute

Change By:	Sebastien Rosset

The Gradle plugin has the following documentation for the "Root Build script" attribute:

{ quote} { { If your workspace has the top-level build.gradle in somewhere other than the module root directory, specify the path (relative to the module root) here, such as ${workspace}/parent/ instead of just ${workspace}. If left empty, defaults to build.gradle}} {quote}

The doc is confusing because:
1) The doc states the path is relative to the module root, but at the same time it provides an example with an absolute path - assuming ${workspace} is expanded to an absolute path.
2) The doc provides ${workspace} as an example, is this referring to the WORKSPACE environment variable? Then shouldn't it be all caps?
3) It's not clear if the user is supposed to enter a directory name or a file name. The documentation has an example with ${workspace}/parent/ which is a directory, but the doc also states the default is build.gradle, which is a file.