1612 patch version deduction (#1634)

* use git to deduce version before build

* prep version file with git before configuring build

remove the current version from source tree and ignore it, have it generated by building procedure

* format justfile and cleanup comments

* do a full clone and then use git describe --tags for versioning

- deduce label for gold by inspecting last commit that edited the
validation sample files
- set VERSION in production container by copying over just prep-version
- use fetch-depth: 0 whenever we actions/checkout so that we can
successfully git describe --tags whenever we need to

* need a clone of ldmx-sw when validating

Author: tomeichlersmith

.github/actions/common.sh

@@ -22,7 +22,12 @@
 
 # Print the gold label
 ldmx_gold_label() {
-  cat ${LDMX_VERSION_FILE}
+  #  git the commit that last edited any of the validation samples
+  #  use git describe --tags to deduce the tag it is closest to
+  #  cut out the first field which is the name of the closest tag
+  git log -n 1 --pretty=format:"%h" -- ${LDMX_BASE}/ldmx-sw/.github/validation_samples/*/** |\
+    xargs git describe --tags |\
+    cut -f 1 -d -
 }
 
 # container running command
@@ -67,8 +72,6 @@ warn() {
 
 start_group Deduce Common Environment Variables
 export LDMX_BASE=$(cd ${GITHUB_WORKSPACE}/../ && pwd)
-export LDMX_VERSION_FILE=${LDMX_BASE}/ldmx-sw/VERSION
-echo "LDMX_VERSION_FILE=${LDMX_VERSION_FILE}"
 echo "LDMX_BASE=${LDMX_BASE}"
 end_group
 

.github/workflows/basic_test.yml

@@ -17,6 +17,7 @@ jobs:
       uses: actions/checkout@v4
       with:
         submodules: 'recursive'
+        fetch-depth: 0
 
     - name: Install just
       uses: extractions/setup-just@v2

.github/workflows/build_production_image.yml

@@ -40,11 +40,15 @@ jobs:
       uses: actions/checkout@v4
       with:
         submodules: recursive
+        fetch-depth: 0
         ref: ${{ github.event.inputs.branch }}
     -
       name: Determine Image Tags
       id: generate_tag
       run: |
+        # this part is just a copy of just prep-version
+        # TODO: transfer building of the production image to a just recipe
+        git fetch --tags && git describe --tags | cut -f 1 -d '-' > VERSION
         source ${GITHUB_WORKSPACE}/.github/actions/common.sh
         _tags=""
         if [[ $GITHUB_EVENT_NAME == "workflow_dispatch" ]]; then

.github/workflows/compile_clang_lto.yml

@@ -18,6 +18,7 @@ jobs:
       uses: actions/checkout@v4
       with:
         submodules: 'recursive'
+        fetch-depth: 0
 
     - name: Install just
       uses: extractions/setup-just@v2

.github/workflows/docs.yml

@@ -29,6 +29,7 @@ jobs:
       uses: actions/checkout@v4
       with:
         submodules: 'recursive'
+        fetch-depth: 0
 
     - name: Install just
       uses: extractions/setup-just@v2

.github/workflows/generate_pr_gold.yml

@@ -19,19 +19,13 @@ jobs:
       uses: actions/checkout@v4
       with:
         submodules: 'recursive'
+        fetch-depth: 0
 
     - name : Install just
       uses: extractions/setup-just@v2
       with:
           just-version: 1.26.0
 
-    - name: Take care of versioning
-      run: | 
-        source ${GITHUB_WORKSPACE}/.github/actions/common.sh
-        echo "Old Label: $(ldmx_gold_label)"
-        echo "${GITHUB_REF##refs/tags/}" > ${LDMX_VERSION_FILE}
-        echo "New Label: $(ldmx_gold_label)"
-
     - name: Compile and Install ldmx-sw
       run: | 
         just install-denv init configure-force-error
@@ -92,6 +86,7 @@ jobs:
       uses: actions/checkout@v4
       with:
         submodules: 'recursive'
+        fetch-depth: 0
         ref: trunk
 
     - name: Download All the Gold
@@ -106,12 +101,6 @@ jobs:
       id: update-gold
       run: |
         source ${GITHUB_WORKSPACE}/.github/actions/common.sh
-        start_group Update Gold Label
-        echo "Old Label: $(ldmx_gold_label)"
-        echo "${GITHUB_REF##refs/tags/}" > ${LDMX_VERSION_FILE}
-        echo "New Label: $(ldmx_gold_label)"
-        git add ${LDMX_GOLD_LABEL_FILE}
-        end_group
         start_group Copy over new Gold Histograms
         artifacts_d=${{steps.download.outputs.download-path}}
         echo ${artifacts_d}

.github/workflows/new_pre_release.yml

@@ -27,6 +27,7 @@ jobs:
       with:
         submodules: 'recursive'
         ref: ${{ github.event.inputs.branch }}
+        fetch-depth: 0
 
     - name: Install just
       uses: extractions/setup-just@v2

.github/workflows/pr_validation.yml

@@ -63,11 +63,11 @@ jobs:
       shell: bash
 
     - name: Git Gold Histograms from trunk
-      run: git checkout origin/trunk -- .github/validation_samples/*/gold.root VERSION
+      run: git checkout origin/trunk -- .github/validation_samples/*/**
       shell: bash
 
     - name: Package ldmx-sw Into Artifact
-      run: tar cf ldmx-sw-package.tar install/ .github/ VERSION
+      run: tar cf ldmx-sw-package.tar install/ .github/
 
     - name: Upload ldmx-sw Package
       uses: actions/upload-artifact@v4
@@ -101,7 +101,14 @@ jobs:
         fi
         echo "HEAD_REF=$HEAD_REF" >> $GITHUB_ENV
 
-        
+    # need clone of ldmx-sw for getting gold tag
+    - name: Checkout ldmx-sw
+      uses: actions/checkout@v4
+      with:
+        submodules: 'recursive'
+        fetch-depth: 0
+        ref: ${{ env.HEAD_REF }}
+
     - name: Download ldmx-sw Package
       uses: actions/download-artifact@v4
       with:

.gitignore

@@ -1,3 +1,5 @@
+# file storing git VERSION for build
+VERSION
 
 # Byte-compiled files
 __pycache__/

VERSION

@@ -50,25 +50,29 @@ export APPTAINER_CACHEDIR := env("APPTAINER_CACHEDIR", LDMX_BASE / ".apptainer")
 _default:
     @just --list --justfile {{ justfile() }} --list-heading "{{ help_message }}"
 
-# this install is private since I'd prefer users knowing what tools they are installing;
-
-# however, the CI needs to install denv before it can run any testing
+# install recipe for the CI, private so users know what tools they have on their computers
 [private]
 install-denv:
     curl -s https://raw.githubusercontent.com/tomeichlersmith/denv/main/install | sh
 
+# prep version file
+[private]
+prep-version:
+    git fetch --tags && git describe --tags | cut -f 1 -d '-' > VERSION
+
 # configure how ldmx-sw will be built
 # added ADDITIONAL_WARNINGS and CLANG_TIDY to help improve code quality
+
 # base configure command defining how cmake is called, private so only experts call it
 [private]
-configure-base *CONFIG:
+configure-base *CONFIG: prep-version
     denv cmake -B build -S . {{ CONFIG }}
 
 # default configure of build when developing
 configure *CONFIG: (configure-base "-DADDITIONAL_WARNINGS=ON -DENABLE_CLANG_TIDY=ON" CONFIG)
 
 # configure minimal option for faster compilation
-configure-quick: (configure-base)
+configure-quick: configure-base
 
 # configure with Address Sanitizer (ASAN) and  UndefinedBehaviorSanitizer (UBSan)
 configure-asan-ubsan: (configure-base "-DENABLE_SANITIZER_UNDEFINED_BEHAVIOR=ON -DENABLE_SANITIZER_ADDRESS=ON")
@@ -77,11 +81,13 @@ configure-asan-ubsan: (configure-base "-DENABLE_SANITIZER_UNDEFINED_BEHAVIOR=ON
 configure-force-error: (configure "-DWARNINGS_AS_ERRORS=ON")
 
 # Use alternative compiler and enable LTO (test compiling only, won't run properly)
-configure-clang-lto: (configure "-DENABLE_LTO=ON -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_C_COMPILER=clang") 
+configure-clang-lto: (configure "-DENABLE_LTO=ON -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_C_COMPILER=clang")
 
 configure-clang-lto-fail-on-warning: (configure "-DENABLE_LTO=ON -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_C_COMPILER=clang -DWARNINGS_AS_ERRORS=ON")
+
 # Keep debug symbols so running with gdb provides more helpful detail
 configure-gdb: (configure-base "-DCMAKE_BUILD_TYPE=Debug")
+
 # compile and install ldmx-sw
 build ncpu=num_cpus():
     denv cmake --build build --target install -- -j{{ ncpu }}
@@ -145,7 +151,7 @@ check:
 # remove the build and install directories of ldmx-sw
 [confirm("This will remove the build and install directories. Are you sure?")]
 clean:
-    rm -r build install
+    rm -r build install VERSION
 
 # format the ldmx-sw source code
 format: format-cpp format-just
@@ -226,12 +232,13 @@ recompFire config_py *ARGS: compile (fire config_py ARGS)
 # install the validation module
 # `python3 -m pip install Validation/` is the standard `pip` install method.
 # We add `--upgrade` to tell `pip` it should overwrite the package if it already has been
-# # installed before which is helpful in the case where someone is updating the code and running
-# # the new code within the container. The `--target install/python/` arguments tell `pip`
-# # where to install the package. This directory is where we currently store our python modules
-# # and is where the container expects them to be. The `--no-cache` argument tells `pip` to
-# # not use a cache for downloading any dependencies from the internet which is necessary since
-# # `pip` will not be able to write to the cache location within the container.
-# # install the python Validation plotting module
+# installed before which is helpful in the case where someone is updating the code and running
+# the new code within the container. The `--target install/python/` arguments tell `pip`
+# where to install the package. This directory is where we currently store our python modules
+# and is where the container expects them to be. The `--no-cache` argument tells `pip` to
+# not use a cache for downloading any dependencies from the internet which is necessary since
+# `pip` will not be able to write to the cache location within the container.
+
+# install the python Validation plotting module
 install-validation:
     denv python3 -m pip install Validation/ --upgrade --target install/python/ --no-cache