docs/release-process/project-release.rst

   1 **************************
   2 Project Standalone Release
   3 **************************
   4
   5 This page explains how a project can release independently outside of the
   6 OpenDaylight simultanious release.
   7
   8 Preparing your project for release
   9 ==================================
  10
  11 A project can produce a staging repository by using one of the following
  12 methods against the {project-name}-maven-stage-{stream} job:
  13
  14 * Leave a comment ``stage-release`` against any patch for the stream to build
  15 * Click ``Build with Parameters`` in Jenkins Web UI for the job
  16
  17 This job performs the following duties:
  18
  19 1. Removes -SNAPSHOT from all pom files
  20 2. Produces a taglist.log, project.patch, and project.bundle files
  21 3. Runs a `mvn clean deploy` to a local staging repo
  22 4. Pushes the staging repo to a Nexus staging repo
  23    https://nexus.opendaylight.org/content/repositories/<REPO_ID>
  24    (REPO_ID is saved to staging-repo.txt on the log server)
  25 5. Archives taglist.log, project.patch, and project.bundle files to log server
  26
  27 The files taglist.log and project.bundle can be used later at release time to
  28 reproduce a byte exact commit of what was built by the Jenkins job. This can
  29 be used to tag the release at release time.
  30
  31 Releasing your project
  32 ======================
  33
  34 Once testing against the staging repo has been completed and project has
  35 determined that the staged repo is ready for release. A release can the be
  36 performed using the self-serve release process:
  37 https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/jjb/lf-release-jobs.html
  38
  39
  40 1. Ask helpdesk the necessary right on jenkins if you do not have them
  41 2. Log on https://jenkins.opendaylight.org/releng/
  42 3. Choose your project dashboard
  43 4. Check your release branch has been successfully staged and note the corresponding log folder
  44 5. Go back to the dashboard and choose the release-merge job
  45 6. Click on build with parameters
  46 7. Fill in the form:
  47
  48 * GERRIT_BRANCH must be changed to the branch name you want to release (e.g. stable/sodium)
  49 * VERSION with your corresponding project version (e.g. 0.4.1)
  50 * LOG_DIR with the relative path of the log from the stage release job (e.g. project-maven-stage-master/17/)
  51 * choose maven DISTRIBUTION_TYPE in the select box
  52 * uncheck USE_RELEASE_FILE box
  53
  54 8. Launch the jenkins job
  55
  56
  57 This job performs the following duties:
  58 * download and patch your project repository
  59 * build the project
  60 * publish the artifacts on nexus
  61 * tag and sign the release on Gerrit
  62