Autorelease Builds
==================

OpenDaylight's primary build pipeline is called "autorelease". It is managed by
the `RelEng/Autorelease`_ project, and primarily takes the form of
`Autorelease's Jenkins jobs`_.

Autorelease builds every project from source. Artifact versions are rewritten
from the -SNAPSHOT suffixes in version control to release versions, like
-Carbon-SR1 or -Nitrogen. This contrasts with distribution jobs, which build
only a few projects from source and use -SNAPSHOT artifact versions. This makes
autorelesae builds slow, but identical to actual releases, whereas distribution
builds are fast but slightly less similar to official releases.

Daily Releases
--------------

`Autorelease's Jenkins jobs`_ run daily for every active branch, including
master.

- `Carbon autorelease job`_
- `Nitrogen autorelease job`_
- `Oxygen autorelease job`_
- `Fluorine autorelease job`_

Each of those jobs, when the build is successful, produces build artifacts that
include an OpenDaylight distribution.

*To download the distribution*

#. Pick an autorelease job that completed successfully (yellow or blue dot)
#. Access its logged console output

   Logs are hosted on logs.opendaylight.org, at URLs like
   `https://logs.opendaylight.org/releng/vex-yul-odl-jenkins-1/autorelease-release-<stream>/
   <build_number>/`, where stream could be "Fluorine" build_number "52".

   There will be a link at the top of build's Jenkins page.

#. Open `deploy-staged-repository.log.gz` in browser

   Search for "staging repository with ID" to find the repository ID, which
   will be of the form "autorelease-1432".

#. Navigate to `OpenDaylight's Nexus`_ and find the staging repository with the same name
#. Drill down into one of these directories to find the build artifacts:

   * Carbon or older: org/opendaylight/integration/distribution-karaf/
   * Nitrogen or newer: org/opendaylight/integration/karaf/

.. note:: Autorelease build artifacts are persevered for 60 days.

Autorelease jobs trigger OpenDaylight's distribution tests when they complete.

*To see the test results*

#. Go to integration-distribution-test-<branch> job's Jenkins page
#. Find the job that started after the autorelease in question finished
#. Open it and explore the subprojects section for test results of all
   the jobs triggered.

   For example, in case of Nitrogen, you can find the list and
   the results of jobs triggered `here`_.

The latest successful autorelease builds can also be easily found in Nexus at
`staging/org/opendaylight/integration/distribution-karaf/`_. Look for
0.5.4-Boron-SR4, 0.6.1-Carbon-SR1, 0.7.0-Nitrogen or similar staging
repositories. Note that the artifacts in these repositories are not
static - they are replaced each time new artifacts are generated. Use the
"autorelease-XXXX" repositories described above for semi-persistent URLs.


Official Releases
-----------------

As a part of the OpenDaylight community's efforts to move towards Continuous
Delivery, there is very little mechanical difference between the automated
daily releases documented above and official releases. The same autorelease
job runs, builds artifacts and kicks off distribution tests against them. When
doing official releases, the OpenDaylight community iterates through those
builds (calling them Release Candidate 1, RC2, ...) until no blocking bugs are
found. The OpenDaylight Technical Steering Committee then hears feedback from
the Release Engineering and Integration/Test teams, and if all's well blesses
the build as an official release. The build's Nexus staging repo is then
promoted to a release repo and publicized (example: `opendaylight.release/org
/opendaylight/integration/distribution-karaf/0.6.0-Carbon`_). Official
releases are persevered forever.

For more information about OpenDaylight releases, including timelines, see the
`Release Plans`_.


.. _RelEng/Autorelease: https://git.opendaylight.org/gerrit/gitweb?p=releng/autorelease.git;a=tree;h=refs/heads/master;hb=refs/heads/master
.. _Autorelease's Jenkins jobs: https://jenkins.opendaylight.org/releng/view/autorelease/
.. _Carbon autorelease job: https://jenkins.opendaylight.org/releng/view/autorelease/job/autorelease-release-carbon/
.. _Nitrogen autorelease job: https://jenkins.opendaylight.org/releng/view/autorelease/job/autorelease-release-nitrogen/
.. _Oxygen autorelease job: https://jenkins.opendaylight.org/releng/view/autorelease/job/autorelease-release-oxygen/
.. _Fluorine autorelease job: https://jenkins.opendaylight.org/releng/view/autorelease/job/autorelease-release-fluorine/
.. _OpenDaylight's Nexus: https://nexus.opendaylight.org/content/repositories/
.. _here: https://jenkins.opendaylight.org/releng/job/integration-distribution-test-nitrogen/
.. _staging/org/opendaylight/integration/distribution-karaf/: https://nexus.opendaylight.org/content/repositories/staging/org/opendaylight/integration/distribution-karaf/
.. _opendaylight.release/org /opendaylight/integration/distribution-karaf/0.6.0-Carbon: https://nexus.opendaylight.org/content/repositories/opendaylight.release/org/opendaylight/integration/distribution-karaf/0.6.0-Carbon/
.. _Release Plans: https://wiki.opendaylight.org/view/Release_Plan