Update Java API doc links to reflect fluorine
[docs.git] / 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 clicking "build" for their
12 {project-name}-maven-release-{stream} job. This job performs the following
13 duties:
14
15 1. Removes -SNAPSHOT from all pom files
16 2. Produces a taglist.log, project.patch, and project.bundle files
17 3. Runs a `mvn clean deploy` to a local staging repo
18 4. Pushes the staging repo to a Nexus staging repo
19    https://nexus.opendaylight.org/content/repositories/<REPO_ID>
20    (REPO_ID is saved to staging-repo.txt on the log server)
21 5. Archives taglist.log, project.patch, and project.bundle files to log server
22
23 The files taglist.log and project.bundle can be used later at release time to
24 reproduce a byte exact commit of what was built by the Jenkins job. This can
25 be used to tag the release at release time.
26
27 Releasing your project
28 ======================
29
30 Once testing against the staging repo has been completed and project has
31 determined that the staged repo is ready for release. A release can the be
32 performed as follows:
33
34 1. Ask helpdesk to sign the artifacts in staging repo
35 2. Ask helpdesk to promote the staging repo
36 3. Download taglist.log and project.bundle
37 4. Read taglist.log and checkout the commit hash listed
38 5. Merge the project.bundle patches
39 6. Git tag the release
40 7. Push release tag to Gerrit
41
42 Steps 4-7 as bash:
43
44 .. code:: bash
45
46     PATCH_DIR=/tmp/patches
47     PROJECT=odlparent
48     VERSION=1.2.3
49     git checkout $(awk '{print $NF}' "$PATCH_DIR/taglist.log")
50     git fetch "$PATCH_DIR/$PROJECT.bundle"
51     git merge --ff-only FETCH_HEAD
52     git tag -asm "$PROJECT $VERSION" "v$VERSION"
53     git push origin "v$VERSION"
54
55 Once complete the Git tag should be available in Gerrit and the Artifacts should
56 appear in the Nexus opendaylight.release repo.