| Joey Armstrong | 3980d70 | 2023-08-23 10:57:18 -0400 | [diff] [blame^] | 1 | Release: voltha-onos |
| 2 | ==================== |
| 3 | |
| 4 | - Tag and branch repositories (order is important) |
| 5 | - Update .gitreview, set defaultbranch=voltha-2.12-beta for commits |
| 6 | - Update VERSION file to prevent future conflicts. |
| 7 | |
| 8 | |
| 9 | Release branching and tagging |
| 10 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 11 | |
| 12 | Releasing repository voltha-lib-go requires tag-then-release branching, |
| 13 | first create a versioned tag 2.12.0-beta then create branch voltha-2.12-beta |
| 14 | from the release tag. |
| 15 | |
| 16 | Repository tag names differ based on repository, golang repositories |
| 17 | use tags with the prefix vee v1.2.3, v2.45.0 |
| 18 | |
| 19 | .. code-block:: shell-session |
| 20 | :caption: First create a release tag |
| 21 | |
| 22 | # Determine repository tagname convention (with/with-out vee) |
| 23 | git clone "ssh://gerrit.opencord.org:29418/${repo_name}.git" |
| 24 | git tag --list-tags |
| 25 | |
| 26 | # --------------------------- |
| 27 | # Step 1 create a release tag |
| 28 | # --------------------------- |
| 29 | local branch_name='voltha-2.12-beta' |
| 30 | local tag_name='v2.12.0-beta' |
| 31 | |
| 32 | git tag -a "$tag_name" -m "${branch_name} release" |
| 33 | git push origin "$tag_name" |
| 34 | |
| 35 | .. code-block:: shell-session |
| 36 | :caption: Create a release branch attached to the release tag |
| 37 | |
| 38 | # ------------------------------------------------------------ |
| 39 | # Step 2 - create a release branch attached to the release tag |
| 40 | # ------------------------------------------------------------ |
| 41 | local branch_name='voltha-2.12-beta' |
| 42 | local tag_name='v2.12.0-beta' |
| 43 | local repo_name='voltha-lib-go' |
| 44 | |
| 45 | git clone "ssh://gerrit.opencord.org:29418/${repo_name}.git" |
| 46 | git fetch --all --tags |
| 47 | |
| 48 | git checkout -b "$branch_name" "tags/tag_name" |
| 49 | git push origin "$branch_name" "tags/$tag_name" |
| 50 | |
| 51 | See Also |
| 52 | -------- |
| 53 | https://docs.voltha.org/master/release_notes/release_process.html |
| 54 | |
| 55 | |
| 56 | .gitreview |
| 57 | ---------- |
| 58 | |
| 59 | .. code-block:: shell-session |
| 60 | :caption: .gitreview for release branch=voltha-2.12 |
| 61 | |
| 62 | grep -v 'defaultbranch=' .gitreview > .gitreview.tmp |
| 63 | echo "defaultbranch=voltha-2.12" >> .gitreview.tmp |
| 64 | mv -f .gitreview.tmp .gitreview |
| 65 | |
| 66 | |
| 67 | .gitreview |
| 68 | ---------- |
| 69 | |
| 70 | .. code-block:: shell-session |
| 71 | :caption: .gitreview for release branch=master |
| 72 | |
| 73 | grep -v 'defaultbranch' .gitreview > .gitreview.tmp |
| 74 | echo "defaultbranch=master" >> .gitreview.tmp |
| 75 | mv -f .gitreview.tmp .gitreview |
| 76 | |
| 77 | |
| 78 | VERSION File |
| 79 | ^^^^^^^^^^^^ |
| 80 | |
| 81 | Minor release version number must be incremented to prevent future conflicts |
| 82 | with the patch branch. When version file contains either 1.2.1 or 1.2.1-dev: |
| 83 | |
| 84 | - branch=main VERSION=1.2.3-dev |
| 85 | |
| 86 | - Update VERSION to contain 1.2.4 or 1.3.0 |
| 87 | - commit and merge |
| 88 | |
| 89 | - branch=voltha-2.12 VERSION=1.2.2 |
| 90 | |
| 91 | - Update release / bug fix branch |
| 92 | - commit and merge |