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

Make HTML step reference honor metasteps

    XMLWordPrintable

Details

    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 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.

            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.
            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 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 added a comment -

            Also kwhetstone will probably need to update this static site generator.

            jglick Jesse Glick added a comment - Also kwhetstone will probably need to update this static site generator .
            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!

            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 !
            jglick Jesse Glick added a comment - rtyler points us to https://github.com/jenkins-infra/pipeline-steps-doc-generator .

            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.

            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.

            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.

            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.

            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

            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

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

              Dates

                Created:
                Updated: