Repository: voltha-lib-go

  • Tag and branch repositories (order is important)

  • Update .gitreview, set defaultbranch=voltha-2.12 for commits

  • Update VERSION file to prevent future conflicts: {major}.{minor+1}.0

## TODO: Replace with bttb.sh script usage

  • git checkout -b voltha-2.12 tags/2.12.0

  • Update .gitreview

  • set defaultbranch=voltha-2.12 for commits

  • master branch

    • Increment version file to prevent collision with release branch.

    • Append a *-dev suffix to the version string

    • {max}.{1+min}.0-dev

Release branching and tagging

Releasing repository voltha-lib-go requires tag-then-release branching, first create a versioned tag 2.12.0 then create branch voltha-2.12 from the release tag.

Repository tag names differ based on repository, golang repositories use tags with the prefix vee v1.2.3, v2.45.0

AUTOMATED: Release script bttb.sh
## -----------------------------------------------------------
## Use the bttb.sh (branch-tag_OR_tag-branch) script to branch/tag.
## Script is aware of how to tag/branch VOLTHA repositories by name.
## -----------------------------------------------------------
% git clone ssh://gerrit.opencord.org:29418/voltha-release.git
% cd voltha-release
% ./bttb.sh --sandbox sandbox --repo voltha-lib-go --version 2.12

.gitreview

Create a release branch attached to the release tag
grep -v 'defaultbranch' .gitreview > .gitreview.tmp
echo "defaultbranch=voltha-2.12" >> .gitreview.tmp
mv -f .gitreview.tmp .gitreview

VERSION File

Minor release version number must be incremented to prevent future conflicts with the patch branch.

  • branch=main VERSION=1.2.3

    • Update VERSION to contain 1.2.4 or 1.3.0

    • commit and merge

    • Update VERSION file/patch branch to contain 1.2.3.1

    • commit and merge

Patch creation on release branch

Note: Devs should create a dev branch for merging rather than manipulating the release branch directly as these instructions will.

  • git checkout -b voltha-2.12 tags/v2.12.0

  • git pull –ff-only origin voltha-2.12

  • git rebase -i voltha-2.12

  • git diff –name-only votlha-2.12 2>&1 | less

  • git review –reviewers foo@foo bar@bar

Patch creation on release branch

docs.voltha.org - create the initial release