docs/jjb/lf-go-jobs.rst

   1 #######
   2 Go Jobs
   3 #######
   4
   5 Macros
   6 ======
   7
   8 lf-go-test
   9 ----------
  10
  11 Calls go-test.sh script against a Go project.
  12
  13 :Required Parameters:
  14
  15     :go-root: Path to the Go project root directory.
  16
  17 lf-go-common
  18 ------------
  19
  20 Common Jenkins configuration for Go jobs.
  21
  22 Job Templates
  23 =============
  24
  25 Go Verify
  26 ---------
  27
  28 Job which runs go test ./... to verify a Go project.
  29 'go test ./...' runs unit tests on current folder and all subfolders.
  30
  31 :Template Names:
  32
  33     - {project-name}-go-verify-{stream}"
  34     - gerrit-go-verify
  35     - github-go-verify
  36
  37 :Comment Trigger: recheck|reverify
  38
  39 :Required parameters:
  40
  41     :build-node: The node to run build on.
  42     :jenkins-ssh-credential: Credential to use for SSH. (Generally configured in defaults.yaml)
  43
  44 :Optional parameters:
  45
  46     :branch: Git branch to fetch for the build. (default: master)
  47     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
  48     :build-timeout: Timeout in minutes before aborting build. (default: 60)
  49     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
  50     :stream: Keyword that represents a release code-name.
  51         Often the same as the branch. (default: master)
  52     :submodule-recursive: Whether to checkout submodules recursively.
  53         (default: true)
  54     :submodule-timeout: Timeout (in minutes) for checkout operation.
  55         (default: 10)
  56     :submodule-disable: Disable submodule checkout operation.
  57         (default: false)
  58     :gerrit_verify_triggers: Override Gerrit Triggers.
  59     :gerrit_trigger_file_paths: Override file paths to filter which file
  60         modifications will trigger a build.