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

Clean up step display

    XMLWordPrintable

Details

    Description

      Adjust how steps are displayed, to make the appearance cleaner and keep a focus on the DSL. Suggested changes:

      • Make Snippet Generator list the StepDescriptor.functionName first, as a sort key, followed by the StepDescriptor.displayName. So for example, you might see a pulldown entry sh: run a Unix shell script.
      • Change the console log to print just the functionName, not the displayName.
        • For steps which add LabelAction, like stage, follow the function name with the label: stage: Production. That probably means this call is no longer useful.
        • For block start/stop nodes, perhaps show something like node { or } // node.
        • Metasteps (checkout, step, wrap) need changes but this is covered by JENKINS-29922.
        • Ideally, use ConsoleNote to render metadata with special markup so it does not distract from build output.
      • Tweak the display of Workflow Steps similarly. (FlowNode.getDisplayName might still be OK here if the implementation were modified somewhat.)

      Attachments

        Issue Links

          depends on

          Bug - A problem which impairs or prevents the functions of the product. JENKINS-26156 Erroneous handling of BodyInvoker.withDisplayName

          • Major - Major loss of function.
          • Resolved

          New Feature - A new feature of the product, which has yet to be developed. JENKINS-26107 Allow stage to operate as a labelled block

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-27394 Render stages in logs as collapsible sections

          • Major - Major loss of function.
          • Resolved

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-28293 Display more information about Pipeline steps

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-31595 Improve metadata logs for parallel step

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved
          is related to

          New Feature - A new feature of the product, which has yet to be developed. JENKINS-29922 Promote delegates of metasteps to top-level functions, deprecate $class

          • Major - Major loss of function.
          • Resolved

          Task - A task that needs to be done. JENKINS-30086 Clean up step help

          • Major - Major loss of function.
          • Resolved

          Activity

            Ascending order - Click to sort in descending order
            View 13 older comments
            scm_issue_link SCM/JIRA link daemon added a comment -

            Code changed in jenkins
            User: Jesse Glick
            Path:
            aggregator/src/test/java/org/jenkinsci/plugins/workflow/WorkflowJobNonRestartingTest.java
            cps/src/main/java/org/jenkinsci/plugins/workflow/cps/nodes/StepAtomNode.java
            cps/src/main/java/org/jenkinsci/plugins/workflow/cps/nodes/StepEndNode.java
            cps/src/main/java/org/jenkinsci/plugins/workflow/cps/nodes/StepStartNode.java
            http://jenkins-ci.org/commit/workflow-cps-plugin/e955d74f926ae45bc27c619646bf9d33adbe41fa
            Log:
            Merge pull request #215 from amuniz/JENKINS-30088

            JENKINS-30088 Clean up step display in logs
            Originally-Committed-As: 9ae86c4219d741e1e6e5a99ef1df27fdf08edb5c

            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Jesse Glick Path: aggregator/src/test/java/org/jenkinsci/plugins/workflow/WorkflowJobNonRestartingTest.java cps/src/main/java/org/jenkinsci/plugins/workflow/cps/nodes/StepAtomNode.java cps/src/main/java/org/jenkinsci/plugins/workflow/cps/nodes/StepEndNode.java cps/src/main/java/org/jenkinsci/plugins/workflow/cps/nodes/StepStartNode.java http://jenkins-ci.org/commit/workflow-cps-plugin/e955d74f926ae45bc27c619646bf9d33adbe41fa Log: Merge pull request #215 from amuniz/ JENKINS-30088 JENKINS-30088 Clean up step display in logs Originally-Committed-As: 9ae86c4219d741e1e6e5a99ef1df27fdf08edb5c
            scm_issue_link SCM/JIRA link daemon added a comment -

            Code changed in jenkins
            User: Antonio Muñiz
            Path:
            job/src/main/java/org/jenkinsci/plugins/workflow/job/WorkflowRun.java
            job/src/main/java/org/jenkinsci/plugins/workflow/job/console/WorkflowRunConsoleNote.java
            http://jenkins-ci.org/commit/workflow-job-plugin/d10e6ae4287066d3868fca1af4e42deae7ea47b0
            Log:
            JENKINS-30088 Use the function name instead of the display name

            Originally-Committed-As: 577f2acb256c0c91eaa81abe3177b4248bbaa059

            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Antonio Muñiz Path: job/src/main/java/org/jenkinsci/plugins/workflow/job/WorkflowRun.java job/src/main/java/org/jenkinsci/plugins/workflow/job/console/WorkflowRunConsoleNote.java http://jenkins-ci.org/commit/workflow-job-plugin/d10e6ae4287066d3868fca1af4e42deae7ea47b0 Log: JENKINS-30088 Use the function name instead of the display name Originally-Committed-As: 577f2acb256c0c91eaa81abe3177b4248bbaa059
            scm_issue_link SCM/JIRA link daemon added a comment -

            Code changed in jenkins
            User: Antonio Muñiz
            Path:
            job/src/main/java/org/jenkinsci/plugins/workflow/job/WorkflowRun.java
            job/src/main/java/org/jenkinsci/plugins/workflow/job/console/WorkflowConsoleLogger.java
            job/src/main/java/org/jenkinsci/plugins/workflow/job/console/WorkflowMetadataConsoleFilter.java
            job/src/main/java/org/jenkinsci/plugins/workflow/job/console/WorkflowRunConsoleNote.java
            http://jenkins-ci.org/commit/workflow-job-plugin/99afbdb0f16a0cb49e153d1d9ff157f68476c0ce
            Log:
            JENKINS-30088 Annotate workflow metadata logs

            Originally-Committed-As: 7e2c3a0f52684f989b5c398a9ffd99739a8f7b14

            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Antonio Muñiz Path: job/src/main/java/org/jenkinsci/plugins/workflow/job/WorkflowRun.java job/src/main/java/org/jenkinsci/plugins/workflow/job/console/WorkflowConsoleLogger.java job/src/main/java/org/jenkinsci/plugins/workflow/job/console/WorkflowMetadataConsoleFilter.java job/src/main/java/org/jenkinsci/plugins/workflow/job/console/WorkflowRunConsoleNote.java http://jenkins-ci.org/commit/workflow-job-plugin/99afbdb0f16a0cb49e153d1d9ff157f68476c0ce Log: JENKINS-30088 Annotate workflow metadata logs Originally-Committed-As: 7e2c3a0f52684f989b5c398a9ffd99739a8f7b14
            scm_issue_link SCM/JIRA link daemon added a comment -

            Code changed in jenkins
            User: Antonio Muñiz
            Path:
            cps/src/main/java/org/jenkinsci/plugins/workflow/cps/steps/LoadStepExecution.java
            cps/src/main/java/org/jenkinsci/plugins/workflow/cps/steps/ParallelStepExecution.java
            http://jenkins-ci.org/commit/workflow-cps-plugin/de78cd713a6797db9e6144227da94ee234c6d3ad
            Log:
            Light changes to console logs forgotten in JENKINS-30088 fix

            Originally-Committed-As: 066762028c673b6fd262d5afbcff1321a054aaab

            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Antonio Muñiz Path: cps/src/main/java/org/jenkinsci/plugins/workflow/cps/steps/LoadStepExecution.java cps/src/main/java/org/jenkinsci/plugins/workflow/cps/steps/ParallelStepExecution.java http://jenkins-ci.org/commit/workflow-cps-plugin/de78cd713a6797db9e6144227da94ee234c6d3ad Log: Light changes to console logs forgotten in JENKINS-30088 fix Originally-Committed-As: 066762028c673b6fd262d5afbcff1321a054aaab
            scm_issue_link SCM/JIRA link daemon added a comment -

            Code changed in jenkins
            User: Jesse Glick
            Path:
            src/main/java/org/jenkinsci/plugins/workflow/cps/nodes/StepEndNode.java
            src/main/java/org/jenkinsci/plugins/workflow/cps/nodes/StepStartNode.java
            src/test/java/org/jenkinsci/plugins/workflow/WorkflowJobNonRestartingTest.java
            http://jenkins-ci.org/commit/workflow-cps-plugin/2ef59e10507b5293912913f4865b26ead5568d02
            Log:
            JENKINS-30088 Cleaner appearance of nodes with blocks.
            · Use the function name, not step display name, on the overall start and end nodes.
            · Omit any text on the block start and end nodes.

            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Jesse Glick Path: src/main/java/org/jenkinsci/plugins/workflow/cps/nodes/StepEndNode.java src/main/java/org/jenkinsci/plugins/workflow/cps/nodes/StepStartNode.java src/test/java/org/jenkinsci/plugins/workflow/WorkflowJobNonRestartingTest.java http://jenkins-ci.org/commit/workflow-cps-plugin/2ef59e10507b5293912913f4865b26ead5568d02 Log: JENKINS-30088 Cleaner appearance of nodes with blocks. · Use the function name, not step display name, on the overall start and end nodes. · Omit any text on the block start and end nodes.

            People

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

              Dates

                Created:
                Updated:
                Resolved: