[Asterisk-code-review] build: Refactor the earlier "basebranch" commit (asterisk[16])

George Joseph asteriskteam at digium.com
Mon Feb 28 08:46:15 CST 2022


George Joseph has submitted this change. ( https://gerrit.asterisk.org/c/asterisk/+/18017 )

Change subject: build: Refactor the earlier "basebranch" commit
......................................................................

build: Refactor the earlier "basebranch" commit

Recap from earlier commit:  If you have a development branch for a
major project that will receive gerrit reviews it'll probably be
named something like "development/16/newproject" or a work branch
based on that "development" branch.  That will necessitate
setting "defaultbranch=development/16/newproject" in .gitreview.
The make_version script uses that variable to construct the
asterisk version however, which results in versions
like "GIT-development/16/newproject-ee582a8c7b" which is probably
not what you want.  It also constructs the URLs for downloading
external modules with that version, which will fail.

Fast-forward:

The earlier attempt at adding a "basebranch" variable to
.gitreview didn't work out too well in practice because changes
were made to .gitreview, which is a checked-in file.  So, if
you wanted to rebase your work branch on the base branch, rebase
would attempt to overwrite your .gitreview with the one from
the base branch and complain about a conflict.

This is a slighltly different approach that adds three methods to
determine the mainline branch:

1.  --- MAINLINE_BRANCH from the environment

If MAINLINE_BRANCH is already set in the environment, that will
be used.  This is primarily for the Jenkins jobs.

2.  --- .develvars

Instead of storing the basebranch in .gitreview, it can now be
stored in a non-checked-in ".develvars" file and keyed by the
current branch.  So, if you were working on a branch named
"new-feature-work" based on "development/16/new-feature" and wanted
 to push to that branch in Gerrit but wanted to pull the external
 modules for 16, you'd create the following .develvars file:

[branch "new-feature-work"]
    mainline-branch = 16

The .gitreview file would still look like:

[gerrit]
defaultbranch=development/16/new-feature

...which would cause any reviews pushed from "new-feature-work" to
go to the "development/16/new-feature" branch in Gerrit.

The key is that the .develvars file is NEVER checked in (it's been
added to .gitignore).

3.  --- Well Known Development Branch

If you're actually working in a branch named like
"development/<mainline_branch>/some-feature", the mainline branch
will be parsed from it.

4.  --- .gitreview

If none of the earlier conditions exist, the .gitreview
"defaultbranch" variable will be used just as before.

Change-Id: I1cdeeaa0944bba3f2e01d7a2039559d0c266f8c9
---
M .gitignore
M build_tools/make_version
M tests/CI/buildAsterisk.sh
M tests/CI/installAsterisk.sh
4 files changed, 45 insertions(+), 8 deletions(-)

Approvals:
  Joshua Colp: Looks good to me, but someone else must approve
  Kevin Harwell: Looks good to me, but someone else must approve
  George Joseph: Looks good to me, approved; Approved for Submit



diff --git a/.gitignore b/.gitignore
index 0f31820..1ba75fa 100644
--- a/.gitignore
+++ b/.gitignore
@@ -37,4 +37,4 @@
 out/
 *.orig
 tests/CI/output
-
+.develvars
diff --git a/build_tools/make_version b/build_tools/make_version
index aefe6b1..9dca4bd 100755
--- a/build_tools/make_version
+++ b/build_tools/make_version
@@ -3,11 +3,13 @@
 AWK=${AWK:-awk}
 GIT=${GIT:-git}
 GREP=${GREP:-grep}
+SED=${SED:-sed}
+
 
 if [ -f ${1}/.version ]; then
     cat ${1}/.version
 elif [ -d ${1}/.svn ]; then
-    PARTS=`LANG=C svn info ${1} | ${GREP} URL | ${AWK} '{print $2;}' | sed -e 's:^.*/svn/asterisk/::' | sed -e 's:/: :g'`
+    PARTS=`LANG=C svn info ${1} | ${GREP} URL | ${AWK} '{print $2;}' | ${SED} -e 's:^.*/svn/asterisk/::' | ${SED} -e 's:/: :g'`
     BRANCH=0
     TEAM=0
     TAG=0
@@ -93,16 +95,33 @@
         echo "UNKNOWN__and_probably_unsupported"
         exit 1
     fi
-	cd ${1}
+    cd ${1}
 
     # If the first log commit messages indicates that this is checked into
     # subversion, we'll just use the SVN- form of the revision.
     MODIFIED=""
-    SVN_REV=`${GIT} log --pretty=full -1 | sed -n '/git-svn-id:/ s/.*\@\([^ ]*\) .*/\1/p'`
+    SVN_REV=`${GIT} log --pretty=full -1 | ${SED} -n '/git-svn-id:/ s/.*\@\([^ ]*\) .*/\1/p'`
     if [ -z "$SVN_REV" ]; then
-        MAINLINE_BRANCH=$(${GIT} config -f .gitreview --get gerrit.basebranch)
-        if [ "x${MAINLINE_BRANCH}" = "x" ] ; then
-            MAINLINE_BRANCH=$(${GIT} config -f .gitreview --get gerrit.defaultbranch)
+        # If MAINLINE_BRANCH is already set in the environment, use it.
+        if [ -z "${MAINLINE_BRANCH}" ] ; then
+            # Try to retrieve MAINLINE_BRANCH from a local .develvars file first.
+            # .develvars is keyed by the branch name so we need to get that first.
+            BRANCH=$(${GIT} symbolic-ref --short HEAD)
+            if [ -f .develvars ] ; then
+                MAINLINE_BRANCH=$(${GIT} config -f .develvars --get branch.${BRANCH}.mainline-branch)
+            fi
+
+            # If we didn't find it, see if this is a well-known development branch.
+            # development/<mainline_branch>/<branchname> or
+            # devel/<mainline_branch>/<branchname>
+            if [ "x${MAINLINE_BRANCH}" = "x" ] ; then
+                MAINLINE_BRANCH=$(echo "${BRANCH}" | ${SED} -n -r -e "s at devel(opment)?/([0-9]+)/.+@\2 at p")
+            fi
+
+            # If we didn't find it, get it from .gitreview defaultbranch.
+            if [ "x${MAINLINE_BRANCH}" = "x" ] ; then
+                MAINLINE_BRANCH=$(${GIT} config -f .gitreview --get gerrit.defaultbranch)
+            fi
         fi
 
         VERSION=`${GIT} describe --long --always --tags --dirty=M 2> /dev/null`
@@ -116,7 +135,7 @@
         fi
         echo GIT-${MAINLINE_BRANCH}-${VERSION}
     else
-        PARTS=`LANG=C ${GIT} log --pretty=full | ${GREP} -F "git-svn-id:" | head -1 | ${AWK} '{print $2;}' | sed -e s:^.*/svn/$2/:: | sed -e 's:/: :g' | sed -e 's/@.*$//g'`
+        PARTS=`LANG=C ${GIT} log --pretty=full | ${GREP} -F "git-svn-id:" | head -1 | ${AWK} '{print $2;}' | ${SED} -e s:^.*/svn/$2/:: | ${SED} -e 's:/: :g' | ${SED} -e 's/@.*$//g'`
         BRANCH=0
         TEAM=0
         TAG=0
diff --git a/tests/CI/buildAsterisk.sh b/tests/CI/buildAsterisk.sh
index d8bad70..5f15976 100755
--- a/tests/CI/buildAsterisk.sh
+++ b/tests/CI/buildAsterisk.sh
@@ -17,6 +17,10 @@
 	BRANCH_NAME=$(git config -f .gitreview --get gerrit.defaultbranch)
 fi
 
+if [[ "$BRANCH_NAME" =~ devel(opment)?/([0-9]+)/.+ ]] ; then
+	export MAINLINE_BRANCH="${BASH_REMATCH[2]}"
+fi
+
 gen_cats() {
 	set +x
 	action=$1
@@ -91,6 +95,11 @@
 PKGCONFIG=`which pkg-config`
 _libdir=`${CIDIR}/findLibdir.sh`
 
+_version=$(./build_tools/make_version .)
+for var in BRANCH_NAME MAINLINE_BRANCH OUTPUT_DIR CACHE_DIR CCACHE_DISABLE CCACHE_DIR _libdir _version ; do
+	declare -p $var || :
+done
+
 common_config_args="--prefix=/usr ${_libdir:+--libdir=${_libdir}} --sysconfdir=/etc --with-pjproject-bundled"
 $PKGCONFIG 'jansson >= 2.11' || common_config_args+=" --with-jansson-bundled"
 common_config_args+=" ${CACHE_DIR:+--with-sounds-cache=${CACHE_DIR}/sounds --with-externals-cache=${CACHE_DIR}/externals}"
diff --git a/tests/CI/installAsterisk.sh b/tests/CI/installAsterisk.sh
index d84bf3e..8239772 100755
--- a/tests/CI/installAsterisk.sh
+++ b/tests/CI/installAsterisk.sh
@@ -10,8 +10,17 @@
 if [ x"$DESTDIR" != x ] ; then
 	mkdir -p "$DESTDIR"
 fi
+
+if [[ "$BRANCH_NAME" =~ devel(opment)?/([0-9]+)/.+ ]] ; then
+	export MAINLINE_BRANCH="${BASH_REMATCH[2]}"
+fi
+_version=$(./build_tools/make_version .)
+
 destdir=${DESTDIR:+DESTDIR=$DESTDIR}
 
+declare -p _version
+declare -p destdir
+
 [ $UNINSTALL -gt 0 ] && ${MAKE} ${destdir} uninstall
 [ $UNINSTALL_ALL -gt 0 ] && ${MAKE} ${destdir} uninstall-all
 

-- 
To view, visit https://gerrit.asterisk.org/c/asterisk/+/18017
To unsubscribe, or for help writing mail filters, visit https://gerrit.asterisk.org/settings

Gerrit-Project: asterisk
Gerrit-Branch: 16
Gerrit-Change-Id: I1cdeeaa0944bba3f2e01d7a2039559d0c266f8c9
Gerrit-Change-Number: 18017
Gerrit-PatchSet: 5
Gerrit-Owner: George Joseph <gjoseph at digium.com>
Gerrit-Reviewer: Friendly Automation
Gerrit-Reviewer: George Joseph <gjoseph at digium.com>
Gerrit-Reviewer: Joshua Colp <jcolp at sangoma.com>
Gerrit-Reviewer: Kevin Harwell <kharwell at digium.com>
Gerrit-Reviewer: N A <mail at interlinked.x10host.com>
Gerrit-MessageType: merged
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20220228/acce096d/attachment-0001.html>


More information about the asterisk-code-review mailing list