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 Job Templates
  27 =============
  28
  29 Tox Verify
  30 ----------
  31
  32 Tox runner to verify a project
  33
  34 :Template Names:
  35
  36     - {project-name}-tox-verify-{stream}
  37     - gerrit-tox-verify
  38     - github-tox-verify
  39
  40 :Required Parameters:
  41
  42     :build-node: The node to run build on.
  43     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
  44         be configured in defaults.yaml)
  45
  46 :Optional Parameters:
  47
  48     :branch: The branch to build against. (default: master)
  49     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
  50     :build-timeout: Timeout in seconds before aborting build. (default: 10)
  51     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
  52     :stream: Keyword that can be used to represent a release code-name.
  53         Often the same as the branch. (default: master)
  54     :submodule-recursive: Whether to checkout submodules recursively.
  55         (default: true)
  56     :tox-dir: Directory containing the project's tox.ini relative to
  57         the workspace. Empty works if tox.ini is at project root.
  58         (default: '')
  59     :tox-envs: Tox environments to run. If blank run everything described
  60         in tox.ini. (default: '')