Merge pull request #1377 from slaclab/CI-reorg

Github CI reog and updates

Author: ruck314

.github/workflows/surf_ci.yml

@@ -13,19 +13,17 @@
 # secrets.GH_TOKEN
 # secrets.CONDA_UPLOAD_TOKEN_TAG
 
-name: SURF Integration
+name: CI
 on: [push]
 
 jobs:
 
 # ----------------------------------------------------------------------------
-
-  test_and_document:
-    name: Test And Generate Documentation
+  lint:
+    name: Linting
     runs-on: ubuntu-24.04
-    steps:
 
-      # This step checks out a copy of your repository.
+    steps:
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0
@@ -37,22 +35,19 @@ jobs:
       - name: Install dependencies
         run: |
           sudo apt-get update
-          sudo apt-get install make python3 python3-pip tclsh ghdl
-          sudo apt-get install doxygen doxygen-doc doxygen-latex doxygen-gui graphviz
+          sudo apt-get install -y make python3 python3-pip tclsh ghdl
           python -m pip install --upgrade pip
           pip install -r pip_requirements.txt
           git clone https://github.com/slaclab/ruckus.git
           pip install -r ruckus/scripts/pip_requirements.txt
 
       - name: Check for trailing whitespace and tabs
         run: |
-          # Check for trailing whitespace
           if grep -rnI '[[:blank:]]$' --include=\*.{vhd,tcl,py} .; then
             echo "Error: Trailing whitespace found in the repository!"
             exit 1
           fi
 
-          # Check for tab characters instead of spaces
           if grep -rnI $'\t' --include=\*.{vhd,tcl,py} .; then
             echo "Error: Tab characters found in the repository! Please use spaces for indentation."
             exit 1
@@ -71,18 +66,58 @@ jobs:
         run: |
           source scripts/vsg_linter.sh
 
+      - name: VHDL Syntax Checking
+        run: |
+          make MODULES=$PWD analysis
+
+# ----------------------------------------------------------------------------
+  test:
+    name: Regression Tests
+    runs-on: ubuntu-24.04
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.12
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y make python3 python3-pip tclsh ghdl
+          python -m pip install --upgrade pip
+          pip install -r pip_requirements.txt
+          git clone https://github.com/slaclab/ruckus.git
+          pip install -r ruckus/scripts/pip_requirements.txt
+
       - name: VHDL Regression Testing
         run: |
-          make MODULES=$PWD
+          make MODULES=$PWD import
           python -m pytest --cov -v -n auto tests/
 
       - name: Code Coverage
         run: |
           codecov
           coverage report -m
 
+# ----------------------------------------------------------------------------
+
+  docs:
+    name: Documentation
+    runs-on: ubuntu-24.04
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install documentation tools
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y doxygen doxygen-doc doxygen-latex doxygen-gui graphviz
+
       - name: Generate Documentation
-        if: startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/pre-release'
         run: |
           doxygen Doxyfile
 
@@ -96,7 +131,7 @@ jobs:
 # ----------------------------------------------------------------------------
 
   gen_release:
-    needs: [test_and_document]
+    needs: [lint, test, docs]
     uses: slaclab/ruckus/.github/workflows/gen_release.yml@main
     with:
       version: '1.0.0'
@@ -106,7 +141,7 @@ jobs:
 # ----------------------------------------------------------------------------
 
   conda_build_lib:
-    needs: [test_and_document]
+    needs: [lint, test, docs]
     uses: slaclab/ruckus/.github/workflows/conda_build_lib.yml@main
     with:
       version: '1.0.0'

LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2026, The Board of Trustees of the Leland Stanford Junior 
+Copyright (c) 2026, The Board of Trustees of the Leland Stanford Junior
 University, through SLAC National Accelerator Laboratory (subject to receipt 
 of any required approvals from the U.S. Dept. of Energy). All rights reserved. 
 Redistribution and use in source and binary forms, with or without 

Makefile

@@ -8,58 +8,20 @@
 # contained in the LICENSE.txt file.
 #-----------------------------------------------------------------------------
 
+# Define default target
+target: analysis
+
 ifndef MODULES
 export MODULES = $(abspath $(PWD)/../)
 endif
 
-# GHDL/ruckus source loading
 export RUCKUS_DIR = $(MODULES)/ruckus
 export TOP_DIR    = $(abspath $(PWD))
 export PROJ_DIR   = $(abspath $(PWD))
 export OUT_DIR    = $(PROJ_DIR)/build
 
-# Path to GHDL proc.tcl
-export RUCKUS_PROC_TCL = $(RUCKUS_DIR)/ghdl/proc.tcl
-
-# Bypassing Xilinx Specific code
-export VIVADO_VERSION = -1.0
-
 # Override the submodule check because ruckus external of this repo
 export OVERRIDE_SUBMODULE_LOCKS = 1
 
-# GHDL build flags
-GHDLFLAGS = --workdir=$(OUT_DIR) --ieee=synopsys -fexplicit -frelaxed-rules  --warn-no-library
-
-# Include the shared ruckus Makefile header
-include $(RUCKUS_DIR)/system_shared.mk
-
-# Override system_shared.mk build string
-export GHDL_VERSION = $(shell ghdl -v 2>&1 | head -n 1 | awk '{print $$1, $$2}')
-export BUILD_STRING = $(PROJECT): $(GHDL_VERSION), ${BUILD_SYS_NAME} (${BUILD_SVR_TYPE}), Built ${BUILD_DATE} by ${BUILD_USER}
-
-all: syntax
-
-# Test of the variables
-.PHONY : test
-test:
-	@echo PWD: $(PWD)
-	@echo MODULES: $(MODULES)
-	@echo RUCKUS_DIR: $(RUCKUS_DIR)
-	@echo PROJ_DIR: $(PROJ_DIR)
-	@echo OUT_DIR: $(OUT_DIR)
-	@echo RUCKUS_PROC_TCL: $(RUCKUS_PROC_TCL)
-	@echo VIVADO_VERSION: $(VIVADO_VERSION)
-
-# Find all the source code and load it into GHDL
-.PHONY : src
-src:
-	@$(RUCKUS_DIR)/ghdl/import.tcl > /dev/null 2>&1
-
-# Find all the source code and load it into GHDL
-.PHONY : syntax
-syntax: src
-	@echo "============================================================================="
-	@echo VHDL Syntax Checking:
-	@echo "============================================================================="
-	@ghdl -i $(GHDLFLAGS) --work=surf   $(PROJ_DIR)/build/SRC_VHDL/surf/*
-	@ghdl -i $(GHDLFLAGS) --work=ruckus $(PROJ_DIR)/build/SRC_VHDL/ruckus/*
+# Load the common makefile library
+include $(MODULES)/ruckus/system_ghdl.mk