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

Display meaningful summaries for metasteps

    XMLWordPrintable

    Details

    • Similar Issues:

      Description

      JENKINS-37324 provided some of the infrastructure for displaying useful summaries of steps in visualizations like Blue Ocean, but mainly focused on sh steps and the like, and stopped short of providing useful summaries for some other commonly used steps. For example, you will still see General SCM or General Build Step, which are not helpful.

      Problems include:

      • Blue Ocean apparently does not check StepDescriptor.isMetaStep so as to display, for example, Fingerprinter.DescriptorImpl.displayName Record fingerprints of files to track usage in place of CoreStep.DescriptorImpl.displayName General Build Step when given¬†fingerprint '*.jar'. Compare Snippetizer.QuasiDescriptor.
      • CoreStep, CoreWrapperStep, and GenericSCMStep should override argumentsToString to pass their delegate. (Originally automatic handling of metasteps was planned, but then dropped. Anyway pending JENKINS-37227 this would not yet work for GenericSCMStep.)
      • The default argumentsToString only handles steps passed a single argument, so even after handling metastep delegation, a call like archiveArtifacts artifacts: 'x.txt', fingerprint: true would not be described. It would be more sensible to check DescribableModel.getSoleRequiredParameter. Thus that step would be described as x.txt as a user would probably expect given a quasi-step description of Archive the artifacts.
      • Some build steps like JavadocArchiver still lack a @Symbol and @DataBoundSetter hygiene, but these are solvable on a case-by-case basis in plugins.

        Attachments

          Issue Links

            Activity

            jglick Jesse Glick created issue -
            jglick Jesse Glick made changes -
            Field Original Value New Value
            Summary Display meaningful summaries for compound steps Display meaningful summaries for metasteps
            jglick Jesse Glick made changes -
            Link This issue relates to JENKINS-37324 [ JENKINS-37324 ]
            jglick Jesse Glick made changes -
            Link This issue relates to JENKINS-37227 [ JENKINS-37227 ]
            jglick Jesse Glick made changes -
            Link This issue relates to JENKINS-45109 [ JENKINS-45109 ]
            jglick Jesse Glick made changes -
            Remote Link This issue links to "workflow-cps PR 149 (Web Link)" [ 17175 ]
            jglick Jesse Glick made changes -
            Component/s workflow-cps-plugin [ 21713 ]
            Component/s blueocean-plugin [ 21481 ]
            jglick Jesse Glick made changes -
            Assignee Jesse Glick [ jglick ]
            jglick Jesse Glick made changes -
            Status Open [ 1 ] In Progress [ 3 ]
            jglick Jesse Glick made changes -
            Remote Link This issue links to "workflow-basic-steps PR 47 (Web Link)" [ 17193 ]
            jglick Jesse Glick made changes -
            Status In Progress [ 3 ] In Review [ 10005 ]
            jglick Jesse Glick made changes -
            Status In Review [ 10005 ] Resolved [ 5 ]
            Resolution Fixed [ 1 ]

              People

              • Assignee:
                jglick Jesse Glick
                Reporter:
                jglick Jesse Glick
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: