setup pre commit hook to avoid having left over files from smoke tests in project root directory

[bmerkle]

Current Behavior

we again have left over files from smoke-tests. (e.g. see #20529)

The project root directory is becoming cluttered with temporary log files and data exports generated during local smoke test execution. These files are occasionally being tracked or included in commits unintentionally.

Desired Behavior

A pre-commit hook should be implemented to automatically detect and/or remove these specific smoke test artifacts. If specific files are present, the hook should either:

Clean them automatically before allowing the commit.

Abort the commit and warn the user to run a cleanup script.

@copilot: can we setup some git pre commit hook to avoid this in future ?
e.g. temporary files should not be checked into the VCS project root directory

[bmerkle]

3 possible ways to solve this issue:

1. use .gitignore
   e.g.

# Ignore smoke test artifacts
smoke-test-*.txt

2. Pre-commit Hook (Local Prevention)
   Create .git/hooks/pre-commit

#!/bin/bash

# Pattern to match smoke-test files in the root directory
# This looks for files starting with 'smoke-test-' and ending in '.txt'
PATTERN="^smoke-test-[0-9]+\.txt$"

# Get the list of files staged for commit
STAGED_FILES=$(git diff --cached --name-only)

FORBIDDEN_FOUND=false

for FILE in $STAGED_FILES; do
    # Check if the file is in the root directory (no slashes) 
    # and matches the naming pattern
    if [[ "$FILE" =~ $PATTERN ]]; then
        echo "❌ ERROR: Cannot commit '$FILE'. Root-level smoke test files are prohibited."
        FORBIDDEN_FOUND=true
    fi
done

if [ "$FORBIDDEN_FOUND" = true ]; then
    echo "Please delete these files or move them before committing."
    exit 1
fi

exit 0

3. PR Guard (CI Enforcement)
   Create a file at .github/workflows/lint-filenames.yml

name: Check Filenames
on: [pull_request]

jobs:
  check-root-files:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Ensure no smoke-test files in root
        run: |
          # Count files matching the pattern in the root
          COUNT=$(find . -maxdepth 1 -name "smoke-test-*.txt" | wc -l)
          if [ "$COUNT" -gt 0 ]; then
            echo "Error: Found $COUNT forbidden smoke-test files in the root directory."
            exit 1
          fi

[pelikhan]

These files are created by test workflows that generate files. We'll clean them up but it's not .gitignore. Just ignore those for now.