Added protection hook to commit.

Author: freddieknets

install_protection_hook.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+
+# copyright ############################### #
+# This file is part of the Xboinc Package.  #
+# Copyright (c) CERN, 2023.                 #
+# ######################################### #
+
+
+cat << 'EOF' > pre-commit
+#!/bin/sh
+
+branch="$(git rev-parse --abbrev-ref HEAD)"
+
+if [ "$branch" = "main" ]
+then
+  echo "Cannot commit to main!"
+  echo "Use pull requests or, if package admin, the versioning script."
+  exit 1
+fi
+
+for file in pyproject.toml version.sh LICENSE install_protection_hook.sh pin_xsuite_versions.sh xboinc/general.py 'xboinc/executable/.*'
+do
+  git diff --name-only | grep '^'${file}'$' &> /dev/null
+  if [ $? -eq 0 ]
+  then
+    thisfile=${file/.\*/\*}
+    echo "File $thisfile is protected but has local changes."
+    echo "Restore the file with 'git restore "${thisfile}"' before commiting anything, or force this commit with 'commit --no-verify'."
+    exit 1
+  fi
+  git diff --cached --name-only | grep '^'${file}'$' &> /dev/null
+  if [ $? -eq 0 ]
+  then
+    thisfile=${file/.\*/\*}
+    echo "File $thisfile is protected but has local changes that are staged."
+    echo "Restore the file with 'git restore "${thisfile}"' before commiting anything, or force this commit with 'commit --no-verify'."
+    exit 1
+  fi
+done
+EOF
+
+chmod +x pre-commit
+mv pre-commit .git/hooks/

version.sh

@@ -97,7 +97,7 @@ sed -i "s/\(__version__ =\).*/\1 '"${new_ver}"'/"                 xboinc/general
 sed -i "s/\(assert __version__ ==\).*/\1 '"${new_ver}"'/"         tests/test_version.py
 git reset
 git add pyproject.toml xboinc/general.py tests/test_version.py xboinc/executable/main.c
-git commit -m "Updated version number to v"${new_ver}"."
+git commit --no-verify -m "Updated version number to v"${new_ver}"."
 git push
 
 # Make and accept pull request
@@ -122,3 +122,6 @@ curl \
 
 # Build release and publish to PyPi
 poetry publish --build
+
+
+

xboinc/executable/__init__.py

@@ -4,3 +4,4 @@
 # ######################################### #
 
 from .generate_executable_source import generate_executable_source, generate_executable
+from .default_tracker import get_default_tracker

xboinc/executable/default_tracker.py

@@ -1,9 +1,20 @@
+# copyright ############################### #
+# This file is part of the Xboinc Package.  #
+# Copyright (c) CERN, 2023.                 #
+# ######################################### #
+
 import xtrack as xt
 import xfields as xf
 import xobjects as xo
 import xcoll as xc
 
 
+# ===============================================================================================
+# IMPORTANT
+# ===============================================================================================
+# Only make changes to this file just before a minor version bump (need a separate commit though)
+# to avoid having multiple xboinc versions with out-of-sync executables.
+# ===============================================================================================
 
 def get_default_tracker():
     """

xboinc/executable/main.c

@@ -1,3 +1,8 @@
+// copyright ############################### #
+// This file is part of the Xboinc Package.  #
+// Copyright (c) CERN, 2023.                 #
+// ######################################### #
+
 #include <math.h>
 
 #include "xtrack_tracker.h"
@@ -7,11 +12,18 @@
 #include <stdlib.h>
 
 
+// ===============================================================================================
+// IMPORTANT
+// ===============================================================================================
+// Only make changes to this file just before a minor version bump (need a separate commit though)
+// to avoid having multiple xboinc versions with out-of-sync executables.
+
+// ===============================================================================================
 // Do not change
-// ==================================
+// ===============================================================================================
 // version XXX.YYY as int  (no patch)
 int64_t xboinc_exec_version = 0;
-// ==================================
+// ===============================================================================================
 
 
 int8_t* file_to_buffer(char *filename, int8_t* buf_in){

xboinc/general.py

@@ -8,9 +8,9 @@
 _pkg_root = Path(__file__).parent.absolute()
 
 
-# ====================================================================
+# ==========================================================================================
 # Do not change
-# ====================================================================
+# ==========================================================================================
 
 __version__ = '0.0.3'
 
@@ -27,4 +27,4 @@
     'xcoll'    : '0.2.5',
 }
 
-# ====================================================================
+# ==========================================================================================