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 ]
            Hide
            jglick Jesse Glick added a comment -

            It is possible more support in structs is needed, since HeterogeneousObjectType.getTypes() does not seem to have been updated to handle symbols, so this code is not ready to be updated.

            Show
            jglick Jesse Glick added a comment - It is possible more support in structs is needed, since HeterogeneousObjectType.getTypes() does not seem to have been updated to handle symbols, so this code is not ready to be updated.
            Hide
            jglick Jesse Glick added a comment -

            Probably this code also needs to be updated, since if you have a list of objects of a homogeneous type which has a symbol, you need to write out that symbol for each list element.

            Show
            jglick Jesse Glick added a comment - Probably this code also needs to be updated, since if you have a list of objects of a homogeneous type which has a symbol, you need to write out that symbol for each list element.
            jglick Jesse Glick made changes -
            Link This issue blocks JENKINS-26126 [ JENKINS-26126 ]
            Hide
            jglick Jesse Glick added a comment -

            Also Kristin Whetstone will probably need to update this static site generator.

            Show
            jglick Jesse Glick added a comment - Also Kristin Whetstone will probably need to update this static site generator .
            abayer Andrew Bayer made changes -
            Component/s pipeline-general [ 21692 ]
            abayer Andrew Bayer made changes -
            Component/s workflow-plugin [ 18820 ]
            Hide
            jglick Jesse Glick added a comment -

            Never mind inlining metasteps, the static site is completely useless for these today, since delegates are not even listed!

            Show
            jglick Jesse Glick added a comment - Never mind inlining metasteps, the static site is completely useless for these today, since delegates are not even listed !
            Show
            jglick Jesse Glick added a comment - R. Tyler Croy points us to https://github.com/jenkins-infra/pipeline-steps-doc-generator .
            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 ]
            Hide
            scm_issue_link SCM/JIRA link daemon added a comment -

            Code changed in jenkins
            User: Jesse Glick
            Path:
            pom.xml
            src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/html.groovy
            http://jenkins-ci.org/commit/workflow-cps-plugin/646016200a6aaeabdf2207f7fa75e9a8579918fb
            Log:
            JENKINS-37215 Apply symbols where available.

            Show
            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Jesse Glick Path: pom.xml src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/html.groovy http://jenkins-ci.org/commit/workflow-cps-plugin/646016200a6aaeabdf2207f7fa75e9a8579918fb Log: JENKINS-37215 Apply symbols where available.
            Hide
            scm_issue_link SCM/JIRA link daemon added a comment -

            Code changed in jenkins
            User: Jesse Glick
            Path:
            src/test/java/org/jenkinsci/plugins/workflow/cps/SnippetizerTest.java
            http://jenkins-ci.org/commit/workflow-cps-plugin/509b623188741825e081d348ea229cadb069e449
            Log:
            Proving that JENKINS-37215 fix takes effect: symbols are displayed when available for heterogeneous and homogeneous lists.

            Show
            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Jesse Glick Path: src/test/java/org/jenkinsci/plugins/workflow/cps/SnippetizerTest.java http://jenkins-ci.org/commit/workflow-cps-plugin/509b623188741825e081d348ea229cadb069e449 Log: Proving that JENKINS-37215 fix takes effect: symbols are displayed when available for heterogeneous and homogeneous lists.
            Hide
            scm_issue_link SCM/JIRA link daemon added a comment -

            Code changed in jenkins
            User: Sam Van Oort
            Path:
            pom.xml
            src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/html.groovy
            src/test/java/org/jenkinsci/plugins/workflow/cps/SnippetizerTest.java
            http://jenkins-ci.org/commit/workflow-cps-plugin/b5542d99c8fba610538e1974a86785e62223c230
            Log:
            Merge pull request #203 from jglick/symbols-JENKINS-37215

            JENKINS-37215 Symbol support

            Compare: https://github.com/jenkinsci/workflow-cps-plugin/compare/e61a02a46f08...b5542d99c8fb

            Show
            scm_issue_link SCM/JIRA link daemon added a comment - Code changed in jenkins User: Sam Van Oort Path: pom.xml src/main/resources/org/jenkinsci/plugins/workflow/cps/Snippetizer/html.groovy src/test/java/org/jenkinsci/plugins/workflow/cps/SnippetizerTest.java http://jenkins-ci.org/commit/workflow-cps-plugin/b5542d99c8fba610538e1974a86785e62223c230 Log: Merge pull request #203 from jglick/symbols- JENKINS-37215 JENKINS-37215 Symbol support Compare: https://github.com/jenkinsci/workflow-cps-plugin/compare/e61a02a46f08...b5542d99c8fb

              People

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

                Dates

                • Created:
                  Updated: