-
Bug
-
Resolution: Fixed
-
Minor
-
Jenkins ver. 1.642.18.3 (CloudBees Jenkins Enterprise 15.11)
Gradle Plugin
Chrome Web browser
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.
[JENKINS-38479] Grade Plugin: Fix Documentation of the "Root Build script" attribute
Sebastien Rosset
created issue -
Sebastien Rosset
made changes -
| Description |
Original:
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. |
New:
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. |
Sebastien Rosset
made changes -
| Description |
Original:
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. |
New:
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. |
Sebastien Rosset
made changes -
| Description |
Original:
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. |
New:
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. |
Sebastien Rosset
made changes -
| Description |
Original:
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. |
New:
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}} 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. |
Sebastien Rosset
made changes -
| Description |
Original:
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}} 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. |
New:
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. |
Sebastien Rosset
made changes -
| Description |
Original:
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. |
New:
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. |
Sebastien Rosset
made changes -
| Description |
Original:
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. |
New:
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. |
Stefan Wolf
made changes -
| Labels | New: hacktoberfest |
It would be great if you could provide a better description for this option. Either as a comment to this github issue or via a PR to the plugin repository.