docs/jjb/lf-python-jobs.rst

   1 ###########
   2 Python Jobs
   3 ###########
   4
   5 Job Groups
   6 ==========
   7
   8 {project-name}-python-jobs
   9 --------------------------
  10
  11 Jobs for Python projects using Gerrit.
  12
  13 :Includes:
  14
  15     - gerrit-tox-verify
  16
  17 {project-name}-github-python-jobs
  18 ---------------------------------
  19
  20 Jobs for Python projects using GitHub.
  21
  22 :Includes:
  23
  24     - github-tox-verify
  25
  26
  27 Macros
  28 ======
  29
  30 lf-tox-install
  31 --------------
  32
  33 Runs a shell script that installs tox in a Python virtualenv.
  34
  35 :Required Parameters:
  36
  37     :python-version: Base Python version to use in the virtualenv. For example
  38         python2 or python3.
  39
  40
  41 Job Templates
  42 =============
  43
  44 Tox Verify
  45 ----------
  46
  47 Tox runner to verify a project
  48
  49 :Template Names:
  50
  51     - {project-name}-tox-verify-{stream}
  52     - gerrit-tox-verify
  53     - github-tox-verify
  54
  55 :Required Parameters:
  56
  57     :build-node: The node to run build on.
  58     :jenkins-ssh-credential: Credential to use for SSH. (Generally set
  59         in defaults.yaml)
  60
  61 :Optional Parameters:
  62
  63     :branch: The branch to build against. (default: master)
  64     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
  65     :build-timeout: Timeout in seconds before aborting build. (default: 10)
  66     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
  67     :python-version: Version of Python to configure as a base in virtualenv.
  68         (default: python3)
  69     :stream: Keyword representing a release code-name.
  70         Often the same as the branch. (default: master)
  71     :submodule-recursive: Whether to checkout submodules recursively.
  72         (default: true)
  73     :tox-dir: Directory containing the project's tox.ini relative to
  74         the workspace. Empty works if tox.ini is at project root.
  75         (default: '')
  76     :tox-envs: Tox environments to run. If blank run everything described
  77         in tox.ini. (default: '')