Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-38479

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

    XMLWordPrintable

Details

    • Bug
    • Status: Fixed but Unreleased (View Workflow)
    • Minor
    • Resolution: Fixed
    • gradle-plugin
    • Jenkins ver. 1.642.18.3 (CloudBees Jenkins Enterprise 15.11)
      Gradle Plugin
      Chrome Web browser

    Description

      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.

      Attachments

        Activity

          serosset Sebastien Rosset created issue -
          serosset Sebastien Rosset made changes -
          Field Original Value New Value
          Description 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.
          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.
          serosset Sebastien Rosset made changes -
          Description 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.
          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.
          serosset Sebastien Rosset made changes -
          Description 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.
          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.
          serosset Sebastien Rosset made changes -
          Description 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.
          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.
          serosset Sebastien Rosset made changes -
          Description 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.
          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.
          serosset Sebastien Rosset made changes -
          Description 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.
          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.
          serosset Sebastien Rosset made changes -
          Description 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.
          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.
          wolfs Stefan Wolf added a comment -

          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.

          wolfs Stefan Wolf added a comment - 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.
          wolfs Stefan Wolf made changes -
          Labels hacktoberfest

          Hi, 

          I have added a PR to fix this issue.

          https://github.com/jenkinsci/gradle-plugin/pull/86

          kalana Kalana Wijethunga added a comment - Hi,  I have added a PR to fix this issue. https://github.com/jenkinsci/gradle-plugin/pull/86
          kalana Kalana Wijethunga made changes -
          Assignee Stefan Wolf [ wolfs ] Kalana Wijethunga [ kalana ]
          wolfs Stefan Wolf made changes -
          Resolution Fixed [ 1 ]
          Status Open [ 1 ] Fixed but Unreleased [ 10203 ]

          People

            kalana Kalana Wijethunga
            serosset Sebastien Rosset
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: