Set up git pre-push hook; Move project-specific functions under functions/projects/ directory

Author: cwang39403

.githooks/.setup-hooks.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+HOOK_SOURCE=".githooks/pre-push"
+HOOK_DEST=".git/hooks/pre-push"
+
+echo "Setting up Git hooks..."
+
+# Check if source exists
+if [ ! -f "$HOOK_SOURCE" ]; then
+    echo "Hook source not found: $HOOK_SOURCE"
+    exit 1
+fi
+
+# Copy or symlink the pre-push hook
+cp "$HOOK_SOURCE" "$HOOK_DEST"
+chmod +x "$HOOK_DEST"
+
+echo "✅ Git hook installed: $HOOK_DEST"

.githooks/pre-push

@@ -0,0 +1,47 @@
+#!/bin/bash
+
+# When pushing to GitHub. The script checks and blocks files inside BLOCK_PATH from being pushed to the GitHub repository. 
+# This helps avoid project-specific files being shared on a public repository.
+# This does not affect pushes to internal GitLab remotes.
+
+remote_name="$1"
+remote_url="$2"
+
+echo "Pre-push hook triggered for remote $remote_url"
+
+BLOCK_PATH="esdlvalidator/validation/functions/projects/"
+
+# Apply blocking when pushing to GitHub 
+if [[ "$remote_url" == *github.com* ]]; then
+    echo "Pushing to GitHub. Checking files under $BLOCK_PATH ..."
+
+    while read local_ref local_sha remote_ref remote_sha; do
+        # Ignore deleted branches
+        if [[ "$local_sha" =~ ^0+$ ]]; then
+            continue
+        fi
+
+        # Check commits from remote_sha (old) to local_sha (new)
+        range="$remote_sha..$local_sha"
+        if [[ "$remote_sha" =~ ^0+$ ]]; then
+            # New branch push
+            range="$local_sha"
+        fi
+
+        # List all files touched in this range
+        pushed_files=$(git diff --name-only "$range")
+
+        blocked_files=$(echo "$pushed_files" | grep "^$BLOCK_PATH")
+
+        if [[ -n "$blocked_files" ]]; then
+            echo "❌ Push to GitHub rejected! The following files are in the blocked '$BLOCK_PATH' directory:"
+            echo "$blocked_files"
+            echo "➡️ These files must not be pushed to GitHub. Push to GitLab is allowed."
+            exit 1
+        fi
+    done
+
+fi
+
+# Allow push
+exit 0

README.md

@@ -160,6 +160,23 @@ env\Scripts\activate.bat (Windows CMD)
 pip3 install -r requirements.txt
 ```
 
+### Set up Git hooks
+
+At the project root, run the command in a bash terminal to set up git hooks.
+
+```bash
+./.githooks/.setup-hooks.sh
+```
+
+You should see the logs below after the successful setup. 
+
+```
+Setting up Git hooks...
+✅ Git hook installed: .git/hooks/pre-push
+```
+
+The reason for setting up this git hook (`pre-push`) is to block project-specific functions defined under `esdlvalidator/validation/functions/projects/` from being pushed to an open GitHub repository. This does not affect when pushing to the internal gitlab repository.
+
 ### Testing
 
 Use the 'Test' tab is vscode or execute one of the following commands from the root folder
@@ -185,6 +202,12 @@ An example how to start the service using waitress.
 waitress-serve --listen="*:8080" --call "esdlvalidator.api.manage:create_app"
 ```
 
+
+.githooks/.setup-hooks.sh
+Setting up Git hooks...
+✅ Git hook installed: .git/hooks/pre-push
+
+<!-- TODO: say sth. about pyesdl? -->
 <!-- ### Deprecated: Update static ESDL metamodel code
 
 To update the ESDL code to work with the latest version of the ESDL ecore model, update esdl.ecore to the latest version