docs/jjb/lf-release-jobs.rst

   1 .. _lf-global-jjb-release:
   2
   3 ####################
   4 Releng Release Files
   5 ####################
   6
   7 Projects can create a releases directory and then place a release file in it.
   8 Jenkins will pick this up and then promote the artifact from the staging log
   9 directory (log_dir) and tag the release with the defined version.
  10 if a maven_central_url is given artifact will be pushed there as well.
  11
  12 example of a projects release file
  13
  14 .. code-block:: bash
  15
  16     $ cat releases/1.0.0.yaml
  17     ---
  18     distribution_type: 'maven'
  19     version: '1.0.0'
  20     project: 'zzz-test-release'
  21     log_dir: 'zzz-test-release-maven-stage-master/17/'
  22     maven_central_url: 'oss.sonatype.org'
  23
  24 lftools nexus release is used so there must be a lftoolsini section in jenkins
  25 configfiles with a [nexus] section for auth.
  26
  27 Macros
  28 ======
  29
  30 lf-releases
  31 ----------------------
  32
  33 Release verify and merge jobs are the same except for their scm, trigger, and
  34 builders definition. This anchor is the common template.
  35
  36 Job Templates
  37 =============
  38
  39 Release Merge
  40 -------------
  41
  42 Runs:
  43
  44 - sigul-install
  45 - sigul-configuration
  46 - checkout ref from taglist.log
  47 - applies the $PROJECT.bundle
  48 - signs, tags and pushes
  49
  50 .. code-block:: bash
  51
  52    lftools nexus release --server $NEXUS_URL $STAGING_REPO
  53
  54
  55 :Template Name:
  56     - {project-name}-releases-merge
  57
  58 :Comment Trigger: remerge
  59
  60 :Required parameters:
  61
  62     :build-node: The node to run build on.
  63     :jenkins-ssh-credential: Credential to use for SSH. (Generally set
  64         in defaults.yaml)
  65     :stream: run this job against: master
  66
  67 :Optional parameters:
  68
  69     :branch: Git branch to fetch for the build. (default: master)
  70     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
  71     :build-timeout: Timeout in minutes before aborting build. (default: 15)
  72     :project-pattern: Project to trigger build against. (default: \*\*)
  73     :submodule-recursive: Whether to checkout submodules recursively.
  74         (default: false)
  75     :submodule-timeout: Timeout (in minutes) for checkout operation.
  76         (default: 10)
  77
  78     :gerrit_merge_triggers: Override Gerrit Triggers.
  79     :gerrit_trigger_file_paths: Override file paths filter which checks which
  80         file modifications will trigger a build.
  81         **default**::
  82
  83             - compare-type: ANT
  84               pattern: 'releases/*.yaml'
  85
  86
  87 Release Verify
  88 ------------------
  89
  90 Release verify job checks the schema and ensures that the staging-repo.txt.gz
  91 is available on the job.
  92
  93 - sigul-install
  94 - sigul-configuration
  95 - checkout ref from taglist.log
  96 - applies the $PROJECT.bundle
  97 - signs and shows signature
  98
  99
 100 :Template Names:
 101     - {project-name}-releases-verify
 102
 103 :Comment Trigger: recheck|reverify
 104
 105 :Required Parameters:
 106
 107     :build-node: The node to run build on.
 108     :jenkins-ssh-credential: Credential to use for SSH. (Generally set
 109         in defaults.yaml)
 110     :stream: run this job against: master
 111
 112 :Optional Parameters:
 113
 114     :branch: Git branch to fetch for the build. (default: master)
 115     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 116     :build-node: The node to run build on.
 117     :build-timeout: Timeout in minutes before aborting build. (default: 15)
 118     :doc-dir: Directory where tox will place built docs.
 119         as defined in the tox.ini (default: docs/_build/html)
 120     :gerrit-skip-vote: Skip voting for this job. (default: false)
 121     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 122     :project-pattern: Project to trigger build against. (default: \*\*)
 123     :submodule-recursive: Whether to checkout submodules recursively.
 124         (default: false)
 125     :submodule-timeout: Timeout (in minutes) for checkout operation.
 126         (default: 10)
 127
 128     :gerrit_verify_triggers: Override Gerrit Triggers.
 129     :gerrit_trigger_file_paths: Override file paths filter which checks which
 130         file modifications will trigger a build.
 131         **default**::
 132
 133             - compare-type: ANT
 134               pattern: 'releases/*.yaml'