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

JENKINS-61808 breaks doc generation for build and input steps

    XMLWordPrintable

    Details

    • Similar Issues:

      Description

      The changes to PasswordParameterDefinition in JENKINS-61808, specifically making it so that the @DataBoundConstructor has a parameter of type Secret, which is not supported by data binding/introspection via structs, will cause https://github.com/jenkins-infra/pipeline-steps-doc-generator to fail to generate documentation for the build and input steps if it is updated to run against a version of Jenkins that includes JENKINS-61808.

      The error will look like this:

      java.lang.Exception: could not describe PasswordParameterDefinition(name: String, defaultValueAsSecret: org.kohsuke.stapler.NoStaplerConstructorException: There's no @DataBoundConstructor on any constructor of class hudson.util.Secret, description: String)
      

      From a quick look, I think that doc generation is currently running against Jenkins 2.7.1.

        Attachments

          Issue Links

            Activity

            Hide
            jglick Jesse Glick added a comment -

            At a minimum, throw an AssumptionViolatedException if the version of Jenkins is too new for the test to handle, then get that into a plugin release so PCT passes.

            Show
            jglick Jesse Glick added a comment - At a minimum, throw an AssumptionViolatedException if the version of Jenkins is too new for the test to handle, then get that into a plugin release so PCT passes.
            Hide
            dnusbaum Devin Nusbaum added a comment - - edited

            For SnippetizerTest.oneOrMoreArgsStepDocs I will just switch the test to use a different step that has one required argument and other optional arguments and doesn't have anything to do with parameters.

            Show
            dnusbaum Devin Nusbaum added a comment - - edited For SnippetizerTest.oneOrMoreArgsStepDocs I will just switch the test to use a different step that has one required argument and other optional arguments and doesn't have anything to do with parameters.

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              dnusbaum Devin Nusbaum
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated: