Create a script to help update the version automatically (#5454)

* Create a script to help update the version automatically

* Update comment in the update_version script

* Update script to fix special handling for common.h and Makefile.am

* Revise update_version script to only update the other constants in common.h if it is a major release. Reset Makefile.am version to 17:0:0

src/Makefile.am

@@ -18,6 +18,8 @@ else
 PTHREAD_DEF =
 endif
 
+PROTOBUF_VERSION = 17:0:0
+
 if GCC
 # Turn on all warnings except for sign comparison (we ignore sign comparison
 # in Google so our code base have tons of such warnings).
@@ -169,7 +171,7 @@ nobase_include_HEADERS =                                         \
 lib_LTLIBRARIES = libprotobuf-lite.la libprotobuf.la libprotoc.la
 
 libprotobuf_lite_la_LIBADD = $(PTHREAD_LIBS) $(LIBATOMIC_LIBS)
-libprotobuf_lite_la_LDFLAGS = -version-info 17:0:0 -export-dynamic -no-undefined
+libprotobuf_lite_la_LDFLAGS = -version-info $(PROTOBUF_VERSION) -export-dynamic -no-undefined
 if HAVE_LD_VERSION_SCRIPT
 libprotobuf_lite_la_LDFLAGS += -Wl,--version-script=$(srcdir)/libprotobuf-lite.map
 EXTRA_libprotobuf_lite_la_DEPENDENCIES = libprotobuf-lite.map
@@ -214,7 +216,7 @@ libprotobuf_lite_la_SOURCES =                                  \
   google/protobuf/io/zero_copy_stream_impl_lite.cc
 
 libprotobuf_la_LIBADD = $(PTHREAD_LIBS) $(LIBATOMIC_LIBS)
-libprotobuf_la_LDFLAGS = -version-info 17:0:0 -export-dynamic -no-undefined
+libprotobuf_la_LDFLAGS = -version-info $(PROTOBUF_VERSION) -export-dynamic -no-undefined
 if HAVE_LD_VERSION_SCRIPT
 libprotobuf_la_LDFLAGS += -Wl,--version-script=$(srcdir)/libprotobuf.map
 EXTRA_libprotobuf_la_DEPENDENCIES = libprotobuf.map
@@ -305,7 +307,7 @@ libprotobuf_la_SOURCES =                                       \
 nodist_libprotobuf_la_SOURCES = $(nodist_libprotobuf_lite_la_SOURCES)
 
 libprotoc_la_LIBADD = $(PTHREAD_LIBS) libprotobuf.la
-libprotoc_la_LDFLAGS = -version-info 17:0:0 -export-dynamic -no-undefined
+libprotoc_la_LDFLAGS = -version-info $(PROTOBUF_VERSION) -export-dynamic -no-undefined
 if HAVE_LD_VERSION_SCRIPT
 libprotoc_la_LDFLAGS += -Wl,--version-script=$(srcdir)/libprotoc.map
 EXTRA_libprotoc_la_DEPENDENCIES = libprotoc.map

update_version.sh

@@ -0,0 +1,85 @@
+#!/bin/bash
+# Helper script to update version number in various files.
+# Each file has it own string matching syntax to avoid accidentally updating
+# the wrong version number of other dependencies.
+
+if [ "$#" -eq 1 ]; then
+  VERSION=$1
+  IFS='.' read -ra VERSION_INFO <<< "$VERSION"
+fi
+
+if [ "$#" -ne 1 ] || [ ${#VERSION_INFO[@]} -ne 3 ]; then
+  echo "
+Usage: $0 VERSION
+
+Example:
+$0 2.1.3
+"
+  exit 1
+fi
+
+update_version() {
+  file=$2
+  # Replace the version number in the given file.
+  sed -ri "$1" $file
+  # Verify that the version number is updated successfully.
+  if [ $(grep -c $VERSION $file) -eq 0 ]; then
+    echo "$file version is not updated successfully. Please verify."
+    exit 1
+  fi
+}
+
+update_version "s/\[Protocol Buffers\],\[.*\],\[protobuf@googlegroups.com\]/[Protocol Buffers],[$VERSION],[protobuf@googlegroups.com]/g" configure.ac
+update_version "s/^  <version>.*<\/version>/  <version>$VERSION<\/version>/g" java/pom.xml
+update_version "s/^    <version>.*<\/version>/    <version>$VERSION<\/version>/g" java/core/pom.xml
+update_version "s/^    <version>.*<\/version>/    <version>$VERSION<\/version>/g" java/util/pom.xml
+update_version "s/^  <version>.*<\/version>/  <version>$VERSION<\/version>/g" protoc-artifacts/pom.xml
+update_version "s/^  s.version  = '.*'/  s.version  = '$VERSION'/g" Protobuf.podspec
+update_version "s/^__version__ = '.*'/__version__ = '$VERSION'/g" python/google/protobuf/__init__.py
+update_version "s/^    <VersionPrefix>.*<\/VersionPrefix>/    <VersionPrefix>$VERSION<\/VersionPrefix>/g" csharp/src/Google.Protobuf/Google.Protobuf.csproj
+update_version "s/^    <version>.*<\/version>/    <version>$VERSION<\/version>/g" csharp/Google.Protobuf.Tools.nuspec
+update_version "s/^  \"version\": \".*\",/  \"version\": \"$VERSION\",/g" js/package.json
+update_version "s/^  s.version     = \".*\"/  s.version     = \"$VERSION\"/g" ruby/google-protobuf.gemspec
+
+# Special handling for C++ file, where version is X.Y.Z is transformed to X00Y00Z
+CPP_VERSION=${VERSION_INFO[0]}00${VERSION_INFO[1]}00${VERSION_INFO[2]}
+sed -ri "s/^#define GOOGLE_PROTOBUF_VERSION .*/#define GOOGLE_PROTOBUF_VERSION $CPP_VERSION/g" src/google/protobuf/stubs/common.h
+
+# Only update these constants if it is a major release.
+if [ ${VERSION_INFO[2]} -eq 0 ]; then
+  sed -ri "s/^#define GOOGLE_PROTOBUF_MIN_LIBRARY_VERSION .*/#define GOOGLE_PROTOBUF_MIN_LIBRARY_VERSION $CPP_VERSION/g" src/google/protobuf/stubs/common.h
+  sed -ri "s/^#define GOOGLE_PROTOBUF_MIN_PROTOC_VERSION .*/#define GOOGLE_PROTOBUF_MIN_PROTOC_VERSION $CPP_VERSION/g" src/google/protobuf/stubs/common.h
+  sed -ri "s/^static const int kMinHeaderVersionForLibrary = .*/static const int kMinHeaderVersionForLibrary = $CPP_VERSION;/g" src/google/protobuf/stubs/common.h
+  sed -ri "s/^static const int kMinHeaderVersionForProtoc = .*/static const int kMinHeaderVersionForProtoc = $CPP_VERSION;/g" src/google/protobuf/stubs/common.h
+
+  if [ $(grep -c $CPP_VERSION src/google/protobuf/stubs/common.h) -ne 5 ]; then
+    echo "src/google/protobuf/stubs/common.h version is not updated successfully. Please verify."
+    exit 1
+  fi
+else
+  if [ $(grep -c $CPP_VERSION src/google/protobuf/stubs/common.h) -ne 1 ]; then
+    echo "src/google/protobuf/stubs/common.h version is not updated successfully. Please verify."
+    exit 1
+  fi
+fi
+
+# Special handling for src/Makefile.am. If version is X.Y.Z, then the
+# version here should be [Y+OFFSET]:Z:0 where OFFSET is some constant
+# such that the version number is always increasing. 
+PROTOBUF_VERSION_OFFSET=11
+EXPECTED_MAJOR_VERSION=3
+if [ ${VERSION_INFO[0]} -ne ${EXPECTED_MAJOR_VERSION} ]; then
+  echo "Major protobuf version has changed. Please update $0 to readjust
+the PROTOBUF_VERSION_OFFSET and EXPECTED_MAJOR_VERSION such that the
+PROTOBUF_VERSION in src/Makefile.am is always increasing.
+  "
+  exit 1
+fi
+
+PROTOBUF_VERSION_INFO=$((${VERSION_INFO[1]} + $PROTOBUF_VERSION_OFFSET)):${VERSION_INFO[2]}:0
+sed -ri "s/^PROTOBUF_VERSION = .*/PROTOBUF_VERSION = $PROTOBUF_VERSION_INFO/g" src/Makefile.am
+
+if [ $(grep -c $PROTOBUF_VERSION_INFO src/Makefile.am) -eq 0 ]; then
+  echo "src/Makefile.am version is not updated successfully. Please verify."
+  exit 1
+fi