Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In Synopsys Detect for Jenkins versions 2.0.2 and later, several special parameters are automatically escaped. The workflows pertaining to quotation marks and spaces are as follows.

  • Detect properties must be separated by spaces or carriage returns/line feeds.

  • Values containing spaces must be surrounded by either single or double quotation marks ('single' or “double”).

  • Values containing single quotes must be surrounded with double quotation marks.

  • Values containing double quotes must be surrounded with single quotation marks.

Considerations for name escaping conventions

In version 3.0.0, you can turn off auto escaping by setting the environment variable DETECT_PLUGIN_ESCAPING to false.
Jenkins enables you to set an environment variable at different levels, such as globally or on a per-job basis. If you set the environment variable globally to one value, you can set it at the job level to another value. Synopsys recommends setting the environment variable globally to skip escaping (ensuring past jobs work as expected), and then if you want to make jobs with the auto escaping enabled, you modify the environment variable flag in that job's configuration enable escaping the characters. 

Note: In Synopsys Detect plugin version 8, the above recommendations remain the same for agents on Windows systems. For those agents running on 'NIX systems, DETECT_PLUGIN_ESCAPING should be set to false. Ensure that you adhere to the quoting conventions described above. Any input with spaces in the Jenkins configuration should be enclosed in quotes.

For users of Synopsys Detect for Jenkins versions 2.0.0/2.0.1 that are upgrading to version 2.0.2: if you escaped your values, your escape characters are escaped and appear literally.

...