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

Make HTML step reference honor metasteps

    Details

    • Similar Issues:

      Description

      html.groovy and SnippetizerTest.java need to be updated to reflect changes in JENKINS-29922.

      For example, currently under step one of the options for delegate is listed as $class: 'JUnitResultArchiver'. At a minimum this should say something like junit(...) instead.

      It should also indicate in either step or delegate that this is a metastep, meaning that the delegate can be inlined. Better still would be to just show junit as a top-level step to begin with. (This latter consideration does not apply for symbols used in nested configuration.)

      gdsl.groovy and dsld.groovy would need to be updated if they had even gotten this far, but as noted in JENKINS-26126 they have not: for example, GDSL shows only

      method(name: 'step', type: 'Object', params: [delegate:'Map'], doc: 'General Build Step')
      

      which is pretty useless. I suppose in the case of metasteps we could at least offer the inlined delegate without going into nested configuration:

      method(name: 'junit', type: 'Object', params: [testResults:'java.lang.String'], namedParams: [...], doc: 'Publish JUnit test result report')
      

        Attachments

          Issue Links

            Activity

            jglick Jesse Glick created issue -
            jglick Jesse Glick made changes -
            Field Original Value New Value
            Epic Link JENKINS-35394 [ 171187 ]
            jglick Jesse Glick made changes -
            Link This issue blocks JENKINS-29922 [ JENKINS-29922 ]
            jglick Jesse Glick made changes -
            Link This issue blocks JENKINS-26126 [ JENKINS-26126 ]
            abayer Andrew Bayer made changes -
            Component/s pipeline-general [ 21692 ]
            abayer Andrew Bayer made changes -
            Component/s workflow-plugin [ 18820 ]
            jglick Jesse Glick made changes -
            Component/s workflow-cps-plugin [ 21713 ]
            Component/s pipeline [ 21692 ]
            jglick Jesse Glick made changes -
            Link This issue is duplicated by WEBSITE-354 [ WEBSITE-354 ]
            orrc Christopher Orr made changes -
            Link This issue is duplicated by WEBSITE-430 [ WEBSITE-430 ]
            jglick Jesse Glick made changes -
            Summary Update generated documentation for JENKINS-29922 Make HTML step reference honor metasteps
            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 "pipeline-steps-doc-generator PR 14 (Web Link)" [ 20012 ]
            jglick Jesse Glick made changes -
            Remote Link This issue links to "structs PR 35 (Web Link)" [ 20014 ]
            jglick Jesse Glick made changes -
            Remote Link This issue links to "workflow-cps PR 203 (Web Link)" [ 20015 ]
            jglick Jesse Glick made changes -
            Status In Progress [ 3 ] In Review [ 10005 ]

              People

              • Assignee:
                jglick Jesse Glick
                Reporter:
                jglick Jesse Glick
              • Votes:
                2 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                • Created:
                  Updated: