docs/jjb/lf-c-cpp-jobs.rst

   1 ##########
   2 C/C++ Jobs
   3 ##########
   4
   5 Job Templates
   6 =============
   7
   8 CMake Verify
   9 ------------
  10
  11 Verify job which runs cmake && make && make install to test a project build..
  12
  13 :Template Names:
  14
  15     - {project-name}-cmake-verify-{stream}
  16     - gerrit-cmake-verify
  17     - github-cmake-verify
  18
  19 :Comment Trigger: recheck|reverify
  20
  21 :Required parameters:
  22
  23     :build-node: The node to run build on.
  24     :jenkins-ssh-credential: Credential to use for SSH.
  25         (Configure in defaults.yaml)
  26
  27 :Optional parameters:
  28
  29     :branch: Git branch to fetch for the build. (default: master)
  30     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
  31     :build-dir: Directory to build the project in. (default: $WORKSPACE/target)
  32     :build-timeout: Timeout in minutes before aborting build. (default: 60)
  33     :cmake-opts: Parameters to pass to cmake. (default: '')
  34     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
  35     :install-prefix: CMAKE_INSTALL_PREFIX to use for install.
  36         (default: $BUILD_DIR/output)
  37
  38         .. code-block:: bash
  39            :caption: Example
  40
  41            install-prefix: |
  42                #!/bin/bash
  43                echo "Hello World."
  44
  45     :make-opts: Parameters to pass to make. (default: '')
  46     :pre-build: Shell script to run before performing build. Useful for
  47         setting up dependencies. (default: '')
  48     :stream: Keyword that to represent a release code-name.
  49         Often the same as the branch. (default: master)
  50     :submodule-recursive: Whether to checkout submodules recursively.
  51         (default: true)
  52
  53     :gerrit_verify_triggers: Override Gerrit Triggers.
  54     :gerrit_trigger_file_paths: Override file paths which to filter which file
  55         modifications will trigger a build.