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

Log / document the plugin usage in the flow nodes

    XMLWordPrintable

Details

    Description

      Jenkins adds the plugin names and versions to the XML configuration, e.g. like plugin="groovy@1.27". Analyzing config.xml files it is possible to see what pluins are used by a job.

      With workflow this is not possible, since the information what plugin is used, is in the script file. It is probably difficult to analyze the script statically and extract plugin information.

      However, when a script is executed, workflow has the needed information. The steps are already logged to builds/<job-id>/workflow/<step-id>.xml.

      For a git checkout, via the generic SCM API it logs:

      <?xml version='1.0' encoding='UTF-8'?>
<org.jenkinsci.plugins.workflow.support.storage.SimpleXStreamFlowNodeStorage_-Tag plugin="workflow-support@1.11">
  <node class="org.jenkinsci.plugins.workflow.cps.nodes.StepAtomNode" plugin="workflow-cps@1.11">
    <parents class="com.google.common.collect.ImmutableList">
      <org.jenkinsci.plugins.workflow.cps.nodes.StepStartNode>5</org.jenkinsci.plugins.workflow.cps.nodes.StepStartNode>
    </parents>
    <id>6</id>
    <descriptorId>org.jenkinsci.plugins.workflow.steps.scm.GenericSCMStep</descriptorId>
  </node>
...

      Improvement:

      Each step node contains also the used plugin(s) and version. In the above case it needs to log workflow-scm-step and git.

      Attachments

        Issue Links

          is blocking

          Bug - A problem which impairs or prevents the functions of the product. JENKINS-45109 Metasteps fail to display the delegate symbol in console log

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          New Feature - A new feature of the product, which has yet to be developed. JENKINS-34002 Means of declaring a Pipeline's plugin requirements

          • Major - Major loss of function.
          • Open

          New Feature - A new feature of the product, which has yet to be developed. JENKINS-29922 Promote delegates of metasteps to top-level functions, deprecate $class

          • Major - Major loss of function.
          • Resolved

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-28293 Display more information about Pipeline steps

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-35420 Realtime junit report to support Pipeline (was: throws ClassCastException when pipeline run)

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved
          is duplicated by

          Task - A task that needs to be done. JENKINS-37324 We would like a more meaningful description of a step

          • Blocker - Blocks development and/or testing work, production could not run.
          • Closed
          is related to

          Improvement - An improvement or enhancement to an existing feature or task. JENKINS-33995 ExecutorStep::labels should be recorded in the FlowNode graph

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Open
          relates to

          Bug - A problem which impairs or prevents the functions of the product. JENKINS-47428 Problems with the new ArgumentsAction.getResolvedArguments

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Open

          Bug - A problem which impairs or prevents the functions of the product. JENKINS-47101 Pipeline withCredentials step does not mask step descriptions for variables with the same name as existing system variables

          • Major - Major loss of function.
          • Resolved
          links to

          Web Link workflow-api PR 44

          Web Link workflow-cps PR 151

          Activity

            People

              jglick Jesse Glick
              cruftex Jens Wilke
              Votes:
              4 Vote for this issue
              Watchers:
              12 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: