8000 Descriptions for Task Option Values · Issue #16909 · gradle/gradle · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
Descriptions for Task Option Values #16909
Open
@Mazorius

Description

@Mazorius

It would be nice if a developer could provide description for option values of CLI options.

Expected Behavior

It would be nice if a Map<String, String> could be provided to option values

Task :help
Detailed task information for setVersion
Path
     :setVersion
Type
     SetVersion (com.example.task.SetVersion)
Options
     --api     Do not add '0' at the end of a version.
     --increase     Increase the project version by the specified segment.
                    Available values are:
                         MAJOR: 1.2.3 -> 2.0.0
                         MINOR: 1.2.3 -> 1.3.0
                         PATCH: 1.2.3 -> 1.2.4
     --newVersion     Set specified next version.
Description
     Sets the project version
Group
     publishing

Current Behavior

Currently there is only the possibility to add a String[] as option values.

Task :help
Detailed task information for setVersion
Path
     :setVersion
Type
     SetVersion (com.example.task.SetVersion)
Options
     --api     Do not add '0' at the end of a version.
     --increase     Increase the project version by the specified segment.
      Major: 1.2.3 -> 2.0.0
      Minor: 1.2.3 -> 1.3.0
      Patch: 1.2.3 -> 1.2.4
                    Available values are:
                         MAJOR
                         MINOR
                         PATCH
     --newVersion     Set specified next version.
Description
     Sets the project version
Group
     publishing

Context

I write a task that can get CLI optioned which needs some additional information for the users.
I think the current behavior is a bit un-clean.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      0