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

Clean up step help

XMLWordPrintable

      Somebody needs to go through Snippet Generator to review every known Workflow step, checking that:

      • its display name is comprehensible and follows a consistent format
      • it has an inline help block (help.html next to config.jelly) describing the purpose of the step
      • all attributes have help blocks (help-attrName.html) unless the meaning of the attribute is immediately obvious from its title and form control

          [JENKINS-30086] Clean up step help

          Jesse Glick created issue -
          Jesse Glick made changes -
          Link New: This issue is related to JENKINS-30088 [ JENKINS-30088 ]
          Jesse Glick made changes -
          Link New: This issue is related to JENKINS-29095 [ JENKINS-29095 ]
          Antonio Muñiz made changes -
          Assignee Original: Jesse Glick [ jglick ] New: Antonio Muñiz [ amuniz ]
          Antonio Muñiz made changes -
          Status Original: Open [ 1 ] New: In Progress [ 3 ]

          Antonio Muñiz added a comment -

          PR sent: https://github.com/jenkinsci/workflow-plugin/pull/211

          Antonio Muñiz added a comment - PR sent: https://github.com/jenkinsci/workflow-plugin/pull/211

          SCM/JIRA link daemon added a comment -

          Code changed in jenkins
          User: Antonio Muñiz
          Path:
          basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/ArtifactArchiverStep.java
          basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/ErrorStep.java
          basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/PushdStep.java
          basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/PwdStep.java
          basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/TimeoutStep.java
          basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/ToolStep.java
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/ArtifactArchiverStep/help-excludes.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/ArtifactArchiverStep/help-includes.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/ArtifactArchiverStep/help.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/CoreStep/help.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/CoreWrapperStep/help.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/FileExistsStep/help.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/PushdStep/help.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/PwdStep/help.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/ReadFileStep/help.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/RetryStep/help.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/TimeoutStep/help.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/ToolStep/help.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/WriteFileStep/help.html
          cps/src/main/java/org/jenkinsci/plugins/workflow/cps/Snippetizer.java
          cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/block.jelly
          cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/LoadStep/help-path.html
          cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/LoadStep/help.html
          cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/ParallelStep/config.jelly
          cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/ParallelStep/help.html
          durable-task-step/src/main/resources/org/jenkinsci/plugins/workflow/steps/durable_task/BatchScriptStep/help.html
          durable-task-step/src/main/resources/org/jenkinsci/plugins/workflow/steps/durable_task/ShellStep/help.html
          scm-step/src/main/resources/org/jenkinsci/plugins/workflow/steps/scm/GenericSCMStep/help.html
          scm-step/src/main/resources/org/jenkinsci/plugins/workflow/steps/scm/GitStep/help.html
          scm-step/src/main/resources/org/jenkinsci/plugins/workflow/steps/scm/SubversionStep/help.html
          support/src/main/java/org/jenkinsci/plugins/workflow/support/steps/build/BuildTriggerStep.java
          support/src/main/java/org/jenkinsci/plugins/workflow/support/steps/input/InputStep.java
          support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/ExecutorStep/help-label.html
          support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/ExecutorStep/help-value.html
          support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/StageStep/help-concurrency.html
          support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/StageStep/help.html
          support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/WorkspaceStep/help.html
          support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/build/BuildTriggerStep/help.html
          support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help-id.html
          support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help.html
          http://jenkins-ci.org/commit/workflow-plugin/0b1c5dcd53f0a456ef243a360ad36f6f23cc8bbe
          Log:
          JENKINS-30086 Steps help and decription clean up

          SCM/JIRA link daemon added a comment - Code changed in jenkins User: Antonio Muñiz Path: basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/ArtifactArchiverStep.java basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/ErrorStep.java basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/PushdStep.java basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/PwdStep.java basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/TimeoutStep.java basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/ToolStep.java basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/ArtifactArchiverStep/help-excludes.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/ArtifactArchiverStep/help-includes.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/ArtifactArchiverStep/help.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/CoreStep/help.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/CoreWrapperStep/help.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/FileExistsStep/help.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/PushdStep/help.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/PwdStep/help.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/ReadFileStep/help.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/RetryStep/help.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/TimeoutStep/help.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/ToolStep/help.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/WriteFileStep/help.html cps/src/main/java/org/jenkinsci/plugins/workflow/cps/Snippetizer.java cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/block.jelly cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/LoadStep/help-path.html cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/LoadStep/help.html cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/ParallelStep/config.jelly cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/ParallelStep/help.html durable-task-step/src/main/resources/org/jenkinsci/plugins/workflow/steps/durable_task/BatchScriptStep/help.html durable-task-step/src/main/resources/org/jenkinsci/plugins/workflow/steps/durable_task/ShellStep/help.html scm-step/src/main/resources/org/jenkinsci/plugins/workflow/steps/scm/GenericSCMStep/help.html scm-step/src/main/resources/org/jenkinsci/plugins/workflow/steps/scm/GitStep/help.html scm-step/src/main/resources/org/jenkinsci/plugins/workflow/steps/scm/SubversionStep/help.html support/src/main/java/org/jenkinsci/plugins/workflow/support/steps/build/BuildTriggerStep.java support/src/main/java/org/jenkinsci/plugins/workflow/support/steps/input/InputStep.java support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/ExecutorStep/help-label.html support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/ExecutorStep/help-value.html support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/StageStep/help-concurrency.html support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/StageStep/help.html support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/WorkspaceStep/help.html support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/build/BuildTriggerStep/help.html support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help-id.html support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help.html http://jenkins-ci.org/commit/workflow-plugin/0b1c5dcd53f0a456ef243a360ad36f6f23cc8bbe Log: JENKINS-30086 Steps help and decription clean up

          SCM/JIRA link daemon added a comment -

          Code changed in jenkins
          User: Antonio Muñiz
          Path:
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/PwdStep/help.html
          support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help-message.html
          support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help-parameters.html
          http://jenkins-ci.org/commit/workflow-plugin/c357b475b60b4a97fea26046c5457aa60d8f6182
          Log:
          JENKINS-30086 Incorporate content from #203

          SCM/JIRA link daemon added a comment - Code changed in jenkins User: Antonio Muñiz Path: basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/PwdStep/help.html support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help-message.html support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help-parameters.html http://jenkins-ci.org/commit/workflow-plugin/c357b475b60b4a97fea26046c5457aa60d8f6182 Log: JENKINS-30086 Incorporate content from #203
          Jesse Glick made changes -
          Resolution New: Fixed [ 1 ]
          Status Original: In Progress [ 3 ] New: Resolved [ 5 ]

          SCM/JIRA link daemon added a comment -

          Code changed in jenkins
          User: Jesse Glick
          Path:
          basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/ArtifactArchiverStep.java
          basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/ErrorStep.java
          basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/PushdStep.java
          basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/PwdStep.java
          basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/TimeoutStep.java
          basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/ToolStep.java
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/ArtifactArchiverStep/help-excludes.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/ArtifactArchiverStep/help-includes.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/ArtifactArchiverStep/help.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/CoreStep/help.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/CoreWrapperStep/help.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/FileExistsStep/help.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/PushdStep/help.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/PwdStep/help.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/ReadFileStep/help.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/RetryStep/help.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/TimeoutStep/help.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/ToolStep/help.html
          basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/WriteFileStep/help.html
          cps/src/main/java/org/jenkinsci/plugins/workflow/cps/Snippetizer.java
          cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/block.jelly
          cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/LoadStep/help-path.html
          cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/LoadStep/help.html
          cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/ParallelStep/config.jelly
          cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/ParallelStep/help.html
          durable-task-step/src/main/resources/org/jenkinsci/plugins/workflow/steps/durable_task/BatchScriptStep/help.html
          durable-task-step/src/main/resources/org/jenkinsci/plugins/workflow/steps/durable_task/ShellStep/help.html
          scm-step/src/main/resources/org/jenkinsci/plugins/workflow/steps/scm/GenericSCMStep/help.html
          scm-step/src/main/resources/org/jenkinsci/plugins/workflow/steps/scm/GitStep/help.html
          scm-step/src/main/resources/org/jenkinsci/plugins/workflow/steps/scm/SubversionStep/help.html
          support/src/main/java/org/jenkinsci/plugins/workflow/support/steps/build/BuildTriggerStep.java
          support/src/main/java/org/jenkinsci/plugins/workflow/support/steps/input/InputStep.java
          support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/ExecutorStep/help-label.html
          support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/ExecutorStep/help-value.html
          support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/StageStep/help-concurrency.html
          support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/StageStep/help.html
          support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/WorkspaceStep/help.html
          support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/build/BuildTriggerStep/help.html
          support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help-id.html
          support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help-message.html
          support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help-parameters.html
          support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help.html
          http://jenkins-ci.org/commit/workflow-plugin/71a89610d8ce4597fc2a95705301820d15c76501
          Log:
          Merge pull request #211 from amuniz/JENKINS-30086

          JENKINS-30086 Steps help and description clean up

          Compare: https://github.com/jenkinsci/workflow-plugin/compare/672a41d3cf1a...71a89610d8ce

          SCM/JIRA link daemon added a comment - Code changed in jenkins User: Jesse Glick Path: basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/ArtifactArchiverStep.java basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/ErrorStep.java basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/PushdStep.java basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/PwdStep.java basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/TimeoutStep.java basic-steps/src/main/java/org/jenkinsci/plugins/workflow/steps/ToolStep.java basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/ArtifactArchiverStep/help-excludes.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/ArtifactArchiverStep/help-includes.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/ArtifactArchiverStep/help.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/CoreStep/help.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/CoreWrapperStep/help.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/FileExistsStep/help.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/PushdStep/help.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/PwdStep/help.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/ReadFileStep/help.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/RetryStep/help.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/TimeoutStep/help.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/ToolStep/help.html basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/WriteFileStep/help.html cps/src/main/java/org/jenkinsci/plugins/workflow/cps/Snippetizer.java cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/block.jelly cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/LoadStep/help-path.html cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/LoadStep/help.html cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/ParallelStep/config.jelly cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/ParallelStep/help.html durable-task-step/src/main/resources/org/jenkinsci/plugins/workflow/steps/durable_task/BatchScriptStep/help.html durable-task-step/src/main/resources/org/jenkinsci/plugins/workflow/steps/durable_task/ShellStep/help.html scm-step/src/main/resources/org/jenkinsci/plugins/workflow/steps/scm/GenericSCMStep/help.html scm-step/src/main/resources/org/jenkinsci/plugins/workflow/steps/scm/GitStep/help.html scm-step/src/main/resources/org/jenkinsci/plugins/workflow/steps/scm/SubversionStep/help.html support/src/main/java/org/jenkinsci/plugins/workflow/support/steps/build/BuildTriggerStep.java support/src/main/java/org/jenkinsci/plugins/workflow/support/steps/input/InputStep.java support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/ExecutorStep/help-label.html support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/ExecutorStep/help-value.html support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/StageStep/help-concurrency.html support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/StageStep/help.html support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/WorkspaceStep/help.html support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/build/BuildTriggerStep/help.html support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help-id.html support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help-message.html support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help-parameters.html support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/input/InputStep/help.html http://jenkins-ci.org/commit/workflow-plugin/71a89610d8ce4597fc2a95705301820d15c76501 Log: Merge pull request #211 from amuniz/ JENKINS-30086 JENKINS-30086 Steps help and description clean up Compare: https://github.com/jenkinsci/workflow-plugin/compare/672a41d3cf1a...71a89610d8ce

            amuniz Antonio Muñiz
            jglick Jesse Glick
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated:
              Resolved: