Merge "Migrate newer YANG Tools docs to rst"
[docs.git] / docs / release-process / simultaneous-release.rst
1 ********************
2 Simultaneous Release
3 ********************
4
5 This page explains how the OpenDaylight release process works once the TSC has
6 approved a release.
7
8 Preparations
9 ============
10
11 After release candidate is built gpg sign artifacts using odlsign-bulk script in
12 **releng/builder/scripts**.
13
14     .. code-block:: bash
15
16         cd scripts/
17         ./odlsign-bulk <staging-repo-id>  # eg. autorelease-1367
18
19 Releasing OpenDaylight
20 ======================
21
22 - Block submit permissions for registered users and elevate RE's committer rights on gerrit.
23
24     .. figure:: images/gerrit-update-committer-rights.png
25
26 - Export ${RELEASE} and ${BUILDNUM} with current release name and build number.
27
28        .. code-block:: bash
29
30            export RELEASE=Beryllium-SR4
31            export BRANCH=${RELEASE//-*}
32            export BUILDNUM=55
33
34 - Nexus: click release for staging repo **(Helpdesk)**
35 - Nexus: click release for gpgsign repo (created above in Preparations) **(Helpdesk)**
36 - Send email to Helpdesk with binary URL to update website **(Helpdesk)**
37 - Send email to TSC and Release mailing lists announcing release binaries location **(Release Engineering Team)**
38 - Checkout autorelease and switch to release branch eg stable/carbon **(Release Engineering Team)**
39
40     .. code-block:: bash
41
42         git checkout -b stable/${BRANCH,,} origin/stable/${BRANCH,,}
43         git submodule update --init
44         git submodule foreach git checkout stable/${BRANCH,,} origin/stable/${BRANCH,,}
45
46 - Make sure your git repo is setup to push (use git-review)
47
48     .. code-block:: bash
49
50         git submodule foreach 'git review -s'
51
52 - Download patches (*.bundle files and taglist.log.gz) from log server.
53
54     .. code-block:: bash
55
56         mkdir /tmp/patches && cd /tmp/patches
57         wget https://logs.opendaylight.org/releng/jenkins092/autorelease-release-${BRANCH,,}/${BUILDNUM}/archives/all-bundles.tar.gz
58         gunzip all-bundles.tar.gz
59         wget https://logs.opendaylight.org/releng/jenkins092/autorelease-release-${BRANCH,,}/${BUILDNUM}/archives/patches/taglist.log.gz
60         gunzip taglist.log.gz
61
62 - Run the following commands for every project in the release, to apply patches to each project directory.
63
64     .. code-block:: bash
65
66         ../scripts/patch-odl-release.sh /tmp/patches ${RELEASE}
67         git review -y -t ${RELEASE}
68         git push gerrit release/${RELEASE,,}
69
70 - Merge all patches on gerrit in the order generated by merge-order.log
71
72 - Tag autorelease too
73
74     .. code-block:: bash
75
76         git checkout `cat /tmp/patches/taglist.log | grep autorelease | awk '{print $2}'`
77         git submodule foreach git checkout release/${RELEASE,,}
78         git commit -asSm "Release ${RELEASE}"
79         git tag -asm "OpenDaylight ${RELEASE} release" release/${RELEASE,,}
80         git push gerrit release/${RELEASE,,}
81
82 - Re-enable submit permissions for registered users and disable elevated RE committer rights on gerrit.
83
84 - Generate release notes (???)
85
86 - Send email to release/tsc/dev notifying tagging and version bump complete **(Release Engineering Team)**