feat: auto-set version number from git tag (#57)

.github/detect-version.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+# detect the version number from the git tag
+
+echo "Detecting version number..."
+version=0.0.0
+
+pushd $(dirname $0)/..
+
+git_tag=$(git describe --tags --abbrev=0)
+if [ -n "$git_tag" ]; then
+  version=$(echo $git_tag | sed 's;^v;;')
+  echo "VERSION = $version"
+else
+  echo """WARNING: not a git repository
+  setting VERSION to $version
+  edit $(pwd)/.version to set the correct version""" >&2
+fi
+
+echo $version > .version
+
+popd

.github/workflows/linux.yml

@@ -80,6 +80,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with: # settings needed for version number detection
+          clean: false
+          fetch-tags: true
+          fetch-depth: 0
       - name: setup meson
         run: python -m pip install meson ninja
       - name: summarize dependencies
@@ -100,7 +104,10 @@ jobs:
         run: ls *.tar.gz | xargs -I{} tar xzvf {}
       - run: tree
       - name: configure
-        run: ./configure.py --hipo hipo --fmt fmt --examples --no-documentation
+        run: |
+          ./configure.py --hipo hipo --fmt fmt --examples --no-documentation
+          echo '### Iguana Version' >> $GITHUB_STEP_SUMMARY
+          cat .version >> $GITHUB_STEP_SUMMARY
       - name: build
         run: ./install-iguana.sh
       - name: dump build log

.gitignore

@@ -1,5 +1,6 @@
 # build artifacts
 *.ini
+.version
 install-iguana.sh
 /build*/
 /iguana

configure.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 from configparser import ConfigParser
-import argparse, os, sys, textwrap
+import argparse, os, sys, textwrap, subprocess
 
 # constants
 SYSTEM_ASSUMPTION     = 'assume system installation'
@@ -30,8 +30,13 @@ class Formatter(argparse.ArgumentDefaultsHelpFormatter, argparse.RawDescriptionH
 parser_build.add_argument( '--ini', default='build-iguana.ini', type=str, help='name of the output config INI file')
 args = parser.parse_args()
 
-# get prefix absolute path
-prefix = os.path.realpath(args.prefix)
+# get prefix and source absolute paths
+prefix    = os.path.realpath(args.prefix)
+sourceDir = os.path.dirname(os.path.realpath(__file__))
+
+# detect the version number
+subprocess.run('.github/detect-version.sh', cwd=sourceDir)
+print(SEPARATOR)
 
 # set dependency paths
 cmake_prefix_path = []
@@ -76,7 +81,6 @@ def meson_string_array(arr):
 print(SEPARATOR)
 
 # generate the installation script
-sourceDir = os.path.dirname(os.path.realpath(__file__))
 installScript = 'install-iguana.sh'
 with open(installScript, 'w') as fp:
     fp.write(textwrap.dedent(f'''\

doc/setup.md

@@ -57,8 +57,11 @@ Inspect both of them, and if they look correct, proceed with building and instal
 
 Instead of `configure.py`, use `meson` directly for more control:
 
-1. Follow the [note on dependency resolution](dependency_resolution.md)
-2. Build with `meson`, for example
+1. The version number is dynamically determined from the most recent `git` tag; either:
+   - run `.github/detect-version.sh`
+   - put the version number in `.version` in the top-level directory of the repository
+2. Follow the [note on dependency resolution](dependency_resolution.md)
+3. Build with `meson`, for example
 ```bash
 meson setup --prefix=$(pwd)/iguana build-iguana /path/to/iguana/repository
 meson install -C build-iguana

meson.build

@@ -1,7 +1,7 @@
 project(
   'iguana',
   'cpp',
-  version:         '0.1.0',
+  version:         files(meson.project_source_root() / '.version'),
   license:         'LGPLv3',
   default_options: [ 'cpp_std=c++17' ],
   meson_version:   '>=1.1',