[PATCH v2] build - Generate version based on git tags and latest commit hash

[Luke Yelavich]

From: Luke Yelavich <address@hidden>
To: address@hidden

Uses git-version-gen script that various other projecs use with tweaks for
speech-dispatcher tags.

  - v2: Add git-version-gen to EXTRA_DIST
---
 .gitignore      |   2 +
 Makefile.am     |  11 +++-
 configure.ac    |   2 +-
 git-version-gen | 172 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 185 insertions(+), 2 deletions(-)
 create mode 100755 git-version-gen

diff --git a/.gitignore b/.gitignore
index b479803..fa2b199 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,5 +1,7 @@
 .deps
 .libs
+.version
+.tarball-version
 *.o
 *.la
 *.lo
diff --git a/Makefile.am b/Makefile.am
index 4b163b7..4b59d14 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -3,11 +3,20 @@
 pkgconfigdir = $(libdir)/pkgconfig
 pkgconfig_DATA = speech-dispatcher.pc
 
+BUILT_SOURCES = $(top_srcdir)/.version
+
 SUBDIRS= include src config doc po
 
-EXTRA_DIST= ANNOUNCE BUGS FAQ README.packagers README.translators README.style 
build.sh
+EXTRA_DIST= ANNOUNCE BUGS FAQ README.packagers README.translators README.style 
build.sh git-version-gen
 
 MAINTAINERCLEANFILES=configure
 
 testinstall: install check
        cd src/tests && $(MAKE) $(AM_MAKEFLAGS) testinstall
+
+$(top_srcdir)/.version:
+       echo $(VERSION) > address@hidden && mv address@hidden $@
+
+dist-hook:
+       echo $(VERSION) > $(distdir)/.tarball-version
+       echo $(VERSION) > $(distdir)/.version
diff --git a/configure.ac b/configure.ac
index e81ddb1..7e30e35 100644
--- a/configure.ac
+++ b/configure.ac
@@ -2,7 +2,7 @@
 # Process this file with autoconf to produce a configure script.
 
 AC_PREREQ([2.63])
-AC_INIT([speech-dispatcher], [0.8.1], [speechd at lists.freebsoft.org])
+AC_INIT([speech-dispatcher], [m4_esyscmd(./git-version-gen .tarball-version)], 
[speechd at lists.freebsoft.org])
 AM_INIT_AUTOMAKE([foreign])
 m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES])
 LT_PREREQ([2.2])
diff --git a/git-version-gen b/git-version-gen
new file mode 100755
index 0000000..c7f087a
--- /dev/null
+++ b/git-version-gen
@@ -0,0 +1,172 @@
+#!/bin/sh
+# Print a version string.
+scriptversion=2012-09-25.20
+
+# Copyright (C) 2007-2008 Free Software Foundation
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3, or (at your option)
+# any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+# 02110-1301, USA.
+
+# This script is derived from GIT-VERSION-GEN from GIT: http://git.or.cz/.
+# It may be run two ways:
+# - from a git repository in which the "git describe" command below
+#   produces useful output (thus requiring at least one signed tag)
+# - from a non-git-repo directory containing a .tarball-version file, which
+#   presumes this script is invoked like "./git-version-gen .tarball-version".
+
+# In order to use intra-version strings in your project, you will need two
+# separate generated version string files:
+#
+# .tarball-version - present only in a distribution tarball, and not in
+#   a checked-out repository.  Created with contents that were learned at
+#   the last time autoconf was run, and used by git-version-gen.  Must not
+#   be present in either $(srcdir) or $(builddir) for git-version-gen to
+#   give accurate answers during normal development with a checked out tree,
+#   but must be present in a tarball when there is no version control system.
+#   Therefore, it cannot be used in any dependencies.  GNUmakefile has
+#   hooks to force a reconfigure at distribution time to get the value
+#   correct, without penalizing normal development with extra reconfigures.
+#
+# .version - present in a checked-out repository and in a distribution
+#   tarball.  Usable in dependencies, particularly for files that don't
+#   want to depend on config.h but do want to track version changes.
+#   Delete this file prior to any autoconf run where you want to rebuild
+#   files to pick up a version string change; and leave it stale to
+#   minimize rebuild time after unrelated changes to configure sources.
+#
+# It is probably wise to add these two files to .gitignore, so that you
+# don't accidentally commit either generated file.
+#
+# Use the following line in your configure.ac, so that $(VERSION) will
+# automatically be up-to-date each time configure is run (and note that
+# since configure.ac no longer includes a version string, Makefile rules
+# should not depend on configure.ac for version updates).
+#
+# AC_INIT([GNU project],
+#         m4_esyscmd([build-aux/git-version-gen .tarball-version]),
+#         [bug-project at example])
+#
+# Then use the following lines in your Makefile.am, so that .version
+# will be present for dependencies, and so that .tarball-version will
+# exist in distribution tarballs.
+#
+# BUILT_SOURCES = $(top_srcdir)/.version
+# $(top_srcdir)/.version:
+#      echo $(VERSION) > address@hidden && mv address@hidden $@
+# dist-hook:
+#      echo $(VERSION) > $(distdir)/.tarball-version
+#      echo $(VERSION) > $(distdir)/.version
+
+case $# in
+    1) ;;
+    *) echo 1>&2 "Usage: $0 \$srcdir/.tarball-version"; exit 1;;
+esac
+
+tarball_version_file=$1
+nl='
+'
+v=
+
+# First see if there is a tarball-only version file.
+# then try "git describe", then default.
+if test -f $tarball_version_file
+then
+    v=`cat $tarball_version_file` || exit 1
+    case $v in
+       *$nl*) v= ;; # reject multi-line output
+       [0-9]*) ;;
+       *) v= ;;
+    esac
+    test -z "$v" \
+       && echo "$0: WARNING: $tarball_version_file seems to be damaged" 1>&2
+fi
+
+# This is presently used by the GNOME-OSTree build system; it
+# helps support the case where the meta-build system has already
+# determined the git revision, but we may not be able to run "git describe"
+# because we're inside a chroot.
+if test -n "$GIT_DESCRIBE_FOR_BUILD";
+then
+    v=$GIT_DESCRIBE_FOR_BUILD
+fi
+
+if test -n "$v"
+then
+    : # use $v
+elif test -e .git \
+    && v=`git describe --abbrev=4 --match='[0-9]*' HEAD 2>/dev/null` \
+    && [ -n "$v" ]
+then
+    # If we are on a "dev" tag, we need to check that it is not the same
+    # reference as the a previous version tag (this only happens when we are
+    # working with a release tag).
+    # NB The below trick relies on the $v being an exact tag to work which
+    # will only work when HEAD == tag. When further commits have been made on 
top
+    # of the tag, the $v will be supplimented with the number of commits since
+    # that tag and the commit ref of the most recent commit and thus will
+    # fail the test below (as intended)
+    v2=`git describe --abbrev=4 --match='[0-9]\.[0-9]' --contains $v 
2>/dev/null | cut -d'^' -f1`
+    [ -n "$v2" ] && v=$v2
+
+    # Is this a new git that lists number of commits since the last
+    # tag or the previous older version that did not?
+    #   Newer: v6.10-77-g0f8faeb
+    #   Older: v6.10-g0f8faeb
+#    case $v in
+#      *-*-*) : git describe is okay three part flavor ;;
+#      *-*)
+#          : git describe is older two part flavor
+#          # Recreate the number of commits and rewrite such that the
+#          # result is the same as if we were using the newer version
+#          # of git describe.
+#          vtag=`echo "$v" | sed 's/-.*//'`
+#          numcommits=`git rev-list "$vtag"..HEAD | wc -l`
+#          v=`echo "$v" | sed "s/\(.*\)-\(.*\)/\1-$numcommits-\2/"`;
+#          ;;
+#    esac
+
+    # Change the first '-' to a '.', so version-comparing tools work properly.
+    # Remove the "g" in git describe's output string, to save a byte.
+#    v=`echo "$v" | sed 's/-/./;s/\(.*\)-g/\1-/'`;
+    :
+else
+    echo 1>&2 "$0: Failed to determine git revision"
+    exit 1
+fi
+
+v=`echo "$v" |sed 's/^v//'`
+
+# Don't declare a version "dirty" merely because a time stamp has changed.
+git status > /dev/null 2>&1
+
+dirty=`sh -c 'git diff-index --name-only HEAD' 2>/dev/null` || dirty=
+case "$dirty" in
+    '') ;;
+    *) # Append the suffix only if there isn't one already.
+       case $v in
+         *-dirty) ;;
+         *) v="$v-dirty" ;;
+       esac ;;
+esac
+
+# Omit the trailing newline, so that m4_esyscmd can use the result directly.
+echo "$v" | tr -d '\012'
+
+# Local variables:
+# eval: (add-hook 'write-file-hooks 'time-stamp)
+# time-stamp-start: "scriptversion="
+# time-stamp-format: "%:y-%02m-%02d.%02H"
+# time-stamp-end: "$"
+# End:
-- 
2.1.0