Uploaded image for project: 'Infrastructure'
  1. Infrastructure
  2. INFRA-2888

The documentation for the 'sh', 'bat', and 'powershell' steps are missing.

    XMLWordPrintable

    Details

    • Similar Issues:
    • Released As:
      Jan 29, 2021 pipeline step doc generator update

      Description

      The Pipeline page mentions that "sh is a Pipeline step (provided by the Pipeline: Nodes and Processes plugin)"

      The pipeline steps documentation for the Pipeline nodes and processes plugin previously included documentation for the sh, bat, and powershell steps. You can see an example of how the page looked before on the wayback machine for Nov 30, 2020.

      Documentation for those steps is very important for users.

      Before

      After

        Attachments

        1. after.png
          after.png
          48 kB
        2. Before.png
          Before.png
          66 kB

          Activity

          Hide
          markewaite Mark Waite added a comment - - edited

          Zbynek Konecny was able to repair the pipeline step generator recently. I wonder if he has ideas on the cause of this failure?

          The failure seems to be one of many failures logged in the Pipeline steps generator build log as:

          [WARNING] Cannot instantiate org.jenkinsci.plugins.workflow.steps.durable_task.ShellStep$DescriptorImpl 
          java.lang.InstantiationException: java.lang.NoClassDefFoundError: jenkins/tasks/filters/EnvVarsFilterableBuilder
          	at net.java.sezpoz.IndexItem.instance(IndexItem.java:193)
          	at org.jenkinsci.pipeline_steps_doc_generator.HyperLocalPluginManger$SmallSezpoz.safeInstance(HyperLocalPluginManger.java:479)
          	at org.jenkinsci.pipeline_steps_doc_generator.HyperLocalPluginManger$SmallSezpoz._find(HyperLocalPluginManger.java:463)
          	at org.jenkinsci.pipeline_steps_doc_generator.HyperLocalPluginManger$SmallSezpoz.find(HyperLocalPluginManger.java:438)
          	at org.jenkinsci.pipeline_steps_doc_generator.HyperLocalPluginManger$ModClassicPluginStrategy.findComponents(HyperLocalPluginManger.java:382)
          	at org.jenkinsci.pipeline_steps_doc_generator.PipelineStepExtractor.findSteps(PipelineStepExtractor.java:116)
          	at org.jenkinsci.pipeline_steps_doc_generator.PipelineStepExtractor.main(PipelineStepExtractor.java:82)
          Caused by: java.lang.NoClassDefFoundError: jenkins/tasks/filters/EnvVarsFilterableBuilder
          	at java.lang.ClassLoader.defineClass1(Native Method)
          	at java.lang.ClassLoader.defineClass(ClassLoader.java:756)
          	at jenkins.util.AntClassLoader.defineClassFromData(AntClassLoader.java:1139)
          	at hudson.ClassicPluginStrategy$AntClassLoader2.defineClassFromData(ClassicPluginStrategy.java:878)
          	at jenkins.util.AntClassLoader.getClassFromStream(AntClassLoader.java:1310)
          	at jenkins.util.AntClassLoader.findClassInComponents(AntClassLoader.java:1366)
          	at jenkins.util.AntClassLoader.findClass(AntClassLoader.java:1326)
          	at jenkins.util.AntClassLoader.loadClass(AntClassLoader.java:1079)
          	at java.lang.ClassLoader.loadClass(ClassLoader.java:351)
          	at java.lang.ClassLoader.defineClass1(Native Method)
          	at java.lang.ClassLoader.defineClass(ClassLoader.java:756)
          	at jenkins.util.AntClassLoader.defineClassFromData(AntClassLoader.java:1139)
          	at hudson.ClassicPluginStrategy$AntClassLoader2.defineClassFromData(ClassicPluginStrategy.java:878)
          	at jenkins.util.AntClassLoader.getClassFromStream(AntClassLoader.java:1310)
          	at jenkins.util.AntClassLoader.findClassInComponents(AntClassLoader.java:1366)
          	at jenkins.util.AntClassLoader.findClass(AntClassLoader.java:1326)
          	at jenkins.util.AntClassLoader.loadClass(AntClassLoader.java:1079)
          	at java.lang.ClassLoader.loadClass(ClassLoader.java:351)
          	at java.lang.Class.getDeclaringClass0(Native Method)
          	at java.lang.Class.getDeclaringClass(Class.java:1235)
          	at java.lang.Class.getEnclosingClass(Class.java:1277)
          	at hudson.model.Descriptor.<init>(Descriptor.java:270)
          	at org.jenkinsci.plugins.workflow.steps.StepDescriptor.<init>(StepDescriptor.java:55)
          	at org.jenkinsci.plugins.workflow.steps.durable_task.DurableTaskStep$DurableTaskStepDescriptor.<init>(DurableTaskStep.java:153)
          	at org.jenkinsci.plugins.workflow.steps.durable_task.ShellStep$DescriptorImpl.<init>(ShellStep.java:67)
          	at sun.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method)
          	at sun.reflect.NativeConstructorAccessorImpl.newInstance(NativeConstructorAccessorImpl.java:62)
          	at sun.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:45)
          	at java.lang.reflect.Constructor.newInstance(Constructor.java:423)
          	at java.lang.Class.newInstance(Class.java:442)
          	at net.java.sezpoz.IndexItem.instance(IndexItem.java:181)
          	... 6 more
          Caused by: java.lang.ClassNotFoundException: jenkins.tasks.filters.EnvVarsFilterableBuilder
          	at jenkins.util.AntClassLoader.findClassInComponents(AntClassLoader.java:1376)
          	at jenkins.util.AntClassLoader.findClass(AntClassLoader.java:1326)
          	at jenkins.util.AntClassLoader.loadClass(AntClassLoader.java:1079)
          	at java.lang.ClassLoader.loadClass(ClassLoader.java:351)
          	... 37 more
          

          That message seems to block the publishing of the documentation for the sh, bat. powershell and may be blocking other documentation as well.

          Show
          markewaite Mark Waite added a comment - - edited Zbynek Konecny was able to repair the pipeline step generator recently. I wonder if he has ideas on the cause of this failure? The failure seems to be one of many failures logged in the Pipeline steps generator build log as: [WARNING] Cannot instantiate org.jenkinsci.plugins.workflow.steps.durable_task.ShellStep$DescriptorImpl java.lang.InstantiationException: java.lang.NoClassDefFoundError: jenkins/tasks/filters/EnvVarsFilterableBuilder at net.java.sezpoz.IndexItem.instance(IndexItem.java:193) at org.jenkinsci.pipeline_steps_doc_generator.HyperLocalPluginManger$SmallSezpoz.safeInstance(HyperLocalPluginManger.java:479) at org.jenkinsci.pipeline_steps_doc_generator.HyperLocalPluginManger$SmallSezpoz._find(HyperLocalPluginManger.java:463) at org.jenkinsci.pipeline_steps_doc_generator.HyperLocalPluginManger$SmallSezpoz.find(HyperLocalPluginManger.java:438) at org.jenkinsci.pipeline_steps_doc_generator.HyperLocalPluginManger$ModClassicPluginStrategy.findComponents(HyperLocalPluginManger.java:382) at org.jenkinsci.pipeline_steps_doc_generator.PipelineStepExtractor.findSteps(PipelineStepExtractor.java:116) at org.jenkinsci.pipeline_steps_doc_generator.PipelineStepExtractor.main(PipelineStepExtractor.java:82) Caused by: java.lang.NoClassDefFoundError: jenkins/tasks/filters/EnvVarsFilterableBuilder at java.lang.ClassLoader.defineClass1(Native Method) at java.lang.ClassLoader.defineClass(ClassLoader.java:756) at jenkins.util.AntClassLoader.defineClassFromData(AntClassLoader.java:1139) at hudson.ClassicPluginStrategy$AntClassLoader2.defineClassFromData(ClassicPluginStrategy.java:878) at jenkins.util.AntClassLoader.getClassFromStream(AntClassLoader.java:1310) at jenkins.util.AntClassLoader.findClassInComponents(AntClassLoader.java:1366) at jenkins.util.AntClassLoader.findClass(AntClassLoader.java:1326) at jenkins.util.AntClassLoader.loadClass(AntClassLoader.java:1079) at java.lang.ClassLoader.loadClass(ClassLoader.java:351) at java.lang.ClassLoader.defineClass1(Native Method) at java.lang.ClassLoader.defineClass(ClassLoader.java:756) at jenkins.util.AntClassLoader.defineClassFromData(AntClassLoader.java:1139) at hudson.ClassicPluginStrategy$AntClassLoader2.defineClassFromData(ClassicPluginStrategy.java:878) at jenkins.util.AntClassLoader.getClassFromStream(AntClassLoader.java:1310) at jenkins.util.AntClassLoader.findClassInComponents(AntClassLoader.java:1366) at jenkins.util.AntClassLoader.findClass(AntClassLoader.java:1326) at jenkins.util.AntClassLoader.loadClass(AntClassLoader.java:1079) at java.lang.ClassLoader.loadClass(ClassLoader.java:351) at java.lang.Class.getDeclaringClass0(Native Method) at java.lang.Class.getDeclaringClass(Class.java:1235) at java.lang.Class.getEnclosingClass(Class.java:1277) at hudson.model.Descriptor.<init>(Descriptor.java:270) at org.jenkinsci.plugins.workflow.steps.StepDescriptor.<init>(StepDescriptor.java:55) at org.jenkinsci.plugins.workflow.steps.durable_task.DurableTaskStep$DurableTaskStepDescriptor.<init>(DurableTaskStep.java:153) at org.jenkinsci.plugins.workflow.steps.durable_task.ShellStep$DescriptorImpl.<init>(ShellStep.java:67) at sun.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method) at sun.reflect.NativeConstructorAccessorImpl.newInstance(NativeConstructorAccessorImpl.java:62) at sun.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:45) at java.lang.reflect.Constructor.newInstance(Constructor.java:423) at java.lang.Class.newInstance(Class.java:442) at net.java.sezpoz.IndexItem.instance(IndexItem.java:181) ... 6 more Caused by: java.lang.ClassNotFoundException: jenkins.tasks.filters.EnvVarsFilterableBuilder at jenkins.util.AntClassLoader.findClassInComponents(AntClassLoader.java:1376) at jenkins.util.AntClassLoader.findClass(AntClassLoader.java:1326) at jenkins.util.AntClassLoader.loadClass(AntClassLoader.java:1079) at java.lang.ClassLoader.loadClass(ClassLoader.java:351) ... 37 more That message seems to block the publishing of the documentation for the sh , bat . powershell and may be blocking other documentation as well.
          Hide
          timja Tim Jacomb added a comment -

          I think the issue is that the Jenkins core version in the generator is ancient: https://github.com/jenkins-infra/pipeline-steps-doc-generator/blob/ef0a19729cc4197334fd0d1f760cf4658689e418/pom.xml#L69

          Show
          timja Tim Jacomb added a comment - I think the issue is that the Jenkins core version in the generator is ancient: https://github.com/jenkins-infra/pipeline-steps-doc-generator/blob/ef0a19729cc4197334fd0d1f760cf4658689e418/pom.xml#L69
          Hide
          markewaite Mark Waite added a comment -

          I've confirmed that the change from Zbynek Konecny resolves the issue. Tim Jacomb was exactly right that it needed an update of the Jenkins version. Thanks very much to both of them!

          Show
          markewaite Mark Waite added a comment - I've confirmed that the change from Zbynek Konecny resolves the issue. Tim Jacomb was exactly right that it needed an update of the Jenkins version. Thanks very much to both of them!
          Hide
          markewaite Mark Waite added a comment -

          Confirmed that the most recent changes to the pipeline steps doc generator still create the expected content for the powershell step documentation.

          Show
          markewaite Mark Waite added a comment - Confirmed that the most recent changes to the pipeline steps doc generator still create the expected content for the powershell step documentation .

            People

            Assignee:
            Unassigned Unassigned
            Reporter:
            restbndr Anvar Sosnitski
            Votes:
            1 Vote for this issue
            Watchers:
            4 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: