The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Pyenv Pipeline Plugin

pybat: PyEnvVar Batch Script

  • script
    • Type: String
  • encoding (optional)
    Encoding of standard output, if it is being captured.
    • Type: String
  • returnStatus (optional)
    Normally, a script which exits with a nonzero status code will cause the step to fail with an exception. If this option is checked, the return value of the step will instead be the status code. You may then compare it to zero, for example.
    • Type: boolean
  • returnStdout (optional)
    If checked, standard output from the task is returned as the step value as a String, rather than being printed to the build log. (Standard error, if any, will still be printed to the log.) You will often want to call .trim() on the result to strip off a trailing newline.
    • Type: boolean

pysh: PyEnvVar Shell Script

  • script
    • Type: String
  • encoding (optional)
    Encoding of standard output, if it is being captured.
    • Type: String
  • returnStatus (optional)
    Normally, a script which exits with a nonzero status code will cause the step to fail with an exception. If this option is checked, the return value of the step will instead be the status code. You may then compare it to zero, for example.
    • Type: boolean
  • returnStdout (optional)
    If checked, standard output from the task is returned as the step value as a String, rather than being printed to the build log. (Standard error, if any, will still be printed to the log.) You will often want to call .trim() on the result to strip off a trailing newline.
    • Type: boolean

withPythonEnv: Code Block

Wraps a block in a Python virtualenv. Any pysh or pybat steps executed within the block, are executed using the virtualenv specified

Example:

withPythonEnv('python3') {
    pysh 'python --version'
}

The argument supplied to withPythonEnv is the name of the virtualenv to make available to any pysh or pybat steps called within the block.

Initially, withPythonEnv tries to match the string passed to it to a tool name. Currently, this means examining the installed tools for ShiningPanada. If the string matches an installed ShiningPanda Python tool instance, the virtualenv within that block is generated from that ShiningPanda tool.

Otherwise, the text is treated "as-is". You can pass "python" to use the default Python installation of the node that the job runs on, or specify an executable path.

  • pythonInstallation
    • Type: String

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.