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

DSLD / GDSL needs to escape single quotes in documentation

    Details

    • Type: Bug
    • Status: Resolved (View Workflow)
    • Priority: Minor
    • Resolution: Fixed
    • Component/s: workflow-cps-plugin
    • Labels:
      None
    • Environment:
      workflow-cps: 2.18
      pipeline-model-definition: 0.2
      Jenkins: 2.23
    • Similar Issues:

      Description

      The Pipeline Model Definition plugin has a step whose display name includes single quotes.

      This causes a syntax error when using the generated DSLD / GDSL, as the single quotes (here, around "FOO=bar") are unescaped when the doc field is written:

      method(name: 'envVarsForTool', type: 'Object', namedParams: [parameter(name: 'toolId', type: 'java.lang.String'), parameter(name: 'toolVersion', type: 'java.lang.String'), ], doc: 'Fetches the environment variables for a given tool in a list of 'FOO=bar' strings suitable for the withEnv step.')
      

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                rishimanidhar Rishi Manidhar
                Reporter:
                orrc Christopher Orr
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: