-
Task
-
Resolution: Fixed
-
Major
-
Powered by SuggestiMate
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
- is related to
-
JENKINS-29095 "build" step is not documented
-
- Resolved
-
-
JENKINS-30088 Clean up step display
-
- Resolved
-
[JENKINS-30086] Clean up step help
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
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
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
Code changed in jenkins
User: Jesse Glick
Path:
CHANGES.md
http://jenkins-ci.org/commit/workflow-plugin/53e756588642a39d4e2c74590c317f0a904b26b1
Log:
JENKINS-30086 Noting.
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
http://jenkins-ci.org/commit/workflow-basic-steps-plugin/aaa15b946ee10b5d3861ba86fcc1284db6c6c1f7
Log:
JENKINS-30086 Steps help and decription clean up
Originally-Committed-As: 0b1c5dcd53f0a456ef243a360ad36f6f23cc8bbe
Code changed in jenkins
User: Antonio Muñiz
Path:
basic-steps/src/main/resources/org/jenkinsci/plugins/workflow/steps/PwdStep/help.html
http://jenkins-ci.org/commit/workflow-basic-steps-plugin/5171e32e3aea72de483948d99ddc401b2824e268
Log:
JENKINS-30086 Incorporate content from #203
Originally-Committed-As: c357b475b60b4a97fea26046c5457aa60d8f6182
Code changed in jenkins
User: Antonio Muñiz
Path:
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
http://jenkins-ci.org/commit/workflow-scm-step-plugin/9e45ea26338643d8cc4c46978708e74c4dfaf397
Log:
JENKINS-30086 Steps help and decription clean up
Originally-Committed-As: 0b1c5dcd53f0a456ef243a360ad36f6f23cc8bbe
Code changed in jenkins
User: Antonio Muñiz
Path:
support/src/main/java/org/jenkinsci/plugins/workflow/support/steps/build/BuildTriggerStep.java
support/src/main/resources/org/jenkinsci/plugins/workflow/support/steps/build/BuildTriggerStep/help.html
http://jenkins-ci.org/commit/pipeline-build-step-plugin/883b90ec69d580db66da10b6b735b9ba186b4133
Log:
JENKINS-30086 Steps help and decription clean up
Originally-Committed-As: 0b1c5dcd53f0a456ef243a360ad36f6f23cc8bbe
Code changed in jenkins
User: Antonio Muñiz
Path:
support/src/main/java/org/jenkinsci/plugins/workflow/support/steps/input/InputStep.java
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/pipeline-input-step-plugin/a16465233e6dca2a3a4cb0ab82160cf37ea610f9
Log:
JENKINS-30086 Steps help and decription clean up
Originally-Committed-As: 0b1c5dcd53f0a456ef243a360ad36f6f23cc8bbe
Code changed in jenkins
User: Antonio Muñiz
Path:
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/pipeline-input-step-plugin/7e940f2e3deb6724e5353f7d32a8248e04385d46
Log:
JENKINS-30086 Incorporate content from #203
Originally-Committed-As: c357b475b60b4a97fea26046c5457aa60d8f6182
Code changed in jenkins
User: Antonio Muñiz
Path:
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
http://jenkins-ci.org/commit/pipeline-stage-step-plugin/eadc69018722953ba49485035d7ae72250bd67c6
Log:
JENKINS-30086 Steps help and decription clean up
Originally-Committed-As: 0b1c5dcd53f0a456ef243a360ad36f6f23cc8bbe
Code changed in jenkins
User: Antonio Muñiz
Path:
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
http://jenkins-ci.org/commit/workflow-cps-plugin/7e9d43243bc2404b00f9e63445cfbb9489386a03
Log:
JENKINS-30086 Steps help and decription clean up
Originally-Committed-As: 0b1c5dcd53f0a456ef243a360ad36f6f23cc8bbe
Code changed in jenkins
User: Jesse Glick
Path:
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
http://jenkins-ci.org/commit/workflow-cps-plugin/84da6eb12f5aa74b2639531b2c0fc3b4612cca7f
Log:
Merge pull request #211 from amuniz/JENKINS-30086
JENKINS-30086 Steps help and description clean up
Originally-Committed-As: 71a89610d8ce4597fc2a95705301820d15c76501
PR sent: https://github.com/jenkinsci/workflow-plugin/pull/211