docs/release-process/autorelease.rst

   1 ***********
   2 Autorelease
   3 ***********
   4
   5 The Release Engineering - `Autorelease project
   6 <https://wiki-archive.opendaylight.org/view/RelEng/Autorelease>`_
   7 is targeted at building the artifacts that are used in the release candidates
   8 and final full release.
   9
  10 * `Open Gerrit Patches <https://git.opendaylight.org/gerrit/q/project:releng/autorelease+status:open>`_
  11 * `Jenkins Jobs <https://jenkins.opendaylight.org/releng/view/autorelease/>`_
  12
  13 Cloning Autorelease
  14 ===================
  15
  16 To clone all the autorelease repo including it's submodules simply run the
  17 clone command with the '''--recursive''' parameter.
  18
  19 .. code-block:: bash
  20
  21     git clone --recursive https://git.opendaylight.org/gerrit/releng/autorelease
  22
  23 If you forgot to add the --recursive parameter to your git clone you can pull
  24 the submodules after with the following commands.
  25
  26 .. code-block:: bash
  27
  28     git submodule init
  29     git submodule update
  30
  31 Creating Autorelease - Release and RC build
  32 ===========================================
  33
  34 An autorelease release build comes from the autorelease-release-\<branch\> job
  35 which can be found on the autorelease tab in the releng master:
  36
  37 * https://jenkins.opendaylight.org/releng/view/autorelease/
  38
  39 For example to create a Boron release candidate build launch a build from the
  40 autorelease-release-boron job by clicking the '''Build with Parameters'''
  41 button on the left hand menu:
  42
  43 * https://jenkins.opendaylight.org/releng/view/autorelease/job/autorelease-release-boron/
  44
  45
  46 .. note::
  47
  48     The only field that needs to be filled in is the '''RELEASE_TAG''', leave all
  49     other fields to their default setting. Set this to Boron, Boron-RC0,
  50     Boron-RC1, etc... depending on the build you'd like to create.
  51
  52 Adding Autorelease staging repo to settings.xml
  53 ===============================================
  54
  55 If you are building or testing this release in such a way that requires pulling
  56 some of the artifacts from the Nexus repo you may need to modify your
  57 settings.xml to include the staging repo URL as this URL is not part of ODL
  58 Nexus' public or snapshot groups. If you've already cloned the recommended
  59 settings.xml for building ODL you will need to add an additional profile and
  60 activate it by adding these sections to the "\<profiles\>" and
  61 "\<activeProfiles\>" sections (please adjust accordingly).
  62
  63 .. note::
  64
  65     * This is an example and you need to "Add" these example sections to your
  66       settings.xml do not delete your existing sections.
  67     * The URLs in the \<repository\> and \<pluginRepository\> sections will also
  68       need to be updated with the staging repo you want to test.
  69
  70 .. code-block:: xml
  71
  72     <profiles>
  73       <profile>
  74         <id>opendaylight-staging</id>
  75         <repositories>
  76           <repository>
  77             <id>opendaylight-staging</id>
  78             <name>opendaylight-staging</name>
  79             <url>https://nexus.opendaylight.org/content/repositories/automatedweeklyreleases-1062</url>
  80             <releases>
  81               <enabled>true</enabled>
  82               <updatePolicy>never</updatePolicy>
  83             </releases>
  84             <snapshots>
  85               <enabled>false</enabled>
  86             </snapshots>
  87           </repository>
  88         </repositories>
  89         <pluginRepositories>
  90           <pluginRepository>
  91             <id>opendaylight-staging</id>
  92             <name>opendaylight-staging</name>
  93             <url>https://nexus.opendaylight.org/content/repositories/automatedweeklyreleases-1062</url>
  94             <releases>
  95               <enabled>true</enabled>
  96               <updatePolicy>never</updatePolicy>
  97             </releases>
  98             <snapshots>
  99               <enabled>false</enabled>
 100             </snapshots>
 101           </pluginRepository>
 102         </pluginRepositories>
 103       </profile>
 104     </profiles>
 105
 106     <activeProfiles>
 107       <activeProfile>opendaylight-staging</activeProfile>
 108     </activeProfiles>