jenkinsflow

Usage: jenkinsflow [OPTIONS] COMMAND [ARGS]...

  Commandline utilities for jenkinsflow

Options:
  --help  Show this message and exit.

Commands:
  set_build_description  Utility to set/append build description on a...
  set_build_result       Change the result of a Jenkins job.

Usage: jenkinsflow set_build_result [OPTIONS]

  Change the result of a Jenkins job.

  DEPRECATED - You should use shell step exit code to determine result.

  Note: set_build_result can only be done from within the job, not after the
  job has finished. Note: Only available if URL is set in `Jenkins
  <http://jenkins-ci.org/>`_ system configuration.

  This command uses the Jenkins `cli` to change the result. It requires a
  java executable to run the Jenkins `cli`. Please note that in some
  versions of jenkins the cli is broken, it has no manifest file!

Options:
  --result TEXT      The result to set. Should probably be 'unstable'
  --username TEXT    Name of jenkins user with access to the job
  --password TEXT    Password of jenkins user with access to the job.
  --java TEXT        Alternative 'java' executable
  --direct-url TEXT  Jenkins URL. Default is JENKINS_URL/HUDSON_URL env var
                     value. Use this argument if JENKINS_URL is a proxy
                     [default: None]
  --protocol TEXT    The cli protocol to use. See
                     https://jenkins.io/doc/book/managing/cli/. Only
                     'remoting' or unspecified is supported. [default:
                     'remoting'.] Specify '' to not supply this option to the
                     cli (for older Jenkins
  --help             Show this message and exit.

You can also use jenkinsflow.utils.set_build_result module in your python script.

Usage: jenkinsflow set_build_description [OPTIONS]

  Utility to set/append build description on a job build.

Options:
  --description TEXT        The description to set on the build
  --replace / --no-replace  Replace existing description, if any, instead of
                            appending.
  --separator TEXT          A separator to insert between any existing
                            description and the new 'description' if 'replace'
                            is not specified.
  --username TEXT           User Name for Jenkin authentication with secured
                            Jenkins
  --password TEXT           Password of Jenkins User
  --job-name TEXT           Job Name
  --build-number INTEGER    Build Number
  --direct-url TEXT         Jenkins URL - preferably non-proxied. If not
                            specified, the value of JENKINS_URL or HUDSON_URL
                            environment variables will be used.
  --help                    Show this message and exit.

You can also use jenkinsflow.utils.set_build_description module in your python script.