[MERGE] Resolve conflict with divergant changes.

Author: reactive-firewall

.github/workflows/CI-BUILD.yml

@@ -1,6 +1,7 @@
 ---
 name: CI-BUILD
-# Continuous Integration workflow for building, the project
+description: "Continuous Integration workflow for building, the project."
+run-name: Build ${{ github.ref_name }} by @${{ github.actor }}
 #
 # Jobs included:
 # - BUILD: Ensures the project compiles correctly
@@ -19,6 +20,10 @@ permissions: {}
 
 env:
   ENVIRONMENT: ${{ (github.ref == 'refs/heads/stable' || startsWith(github.ref, 'refs/tags/v')) && 'Deployment' || (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/heads/feature') || startsWith(github.ref, 'refs/heads/patch-') || startsWith(github.ref, 'refs/tags/v')) && 'Testing' || 'Experimenting' }}
+  # Define Python versions at the top level -- Expected format: X.Y (e.g., 3.13)
+  PYTHON_DEFAULT: "${{ vars.PYTHON_DEFAULT }}"
+  PYTHON_OLD_MIN: "${{ vars.PYTHON_OLD_MIN }}"  # For Oldest Python versions
+  PYTHON_EXPERIMENTAL: "${{ vars.PYTHON_EXPERIMENTAL }}"  # For future Python versions
 
 jobs:
   BUILD:
@@ -46,7 +51,7 @@ jobs:
           persist-credentials: false
       - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
         with:
-          python-version: "3.12"
+          python-version: "${{ vars.PYTHON_DEFAULT }}"
       - name: Pre-Clean
         id: clean
         run: make -j1 -f Makefile purge 2>/dev/null || true
@@ -77,28 +82,28 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.10", "3.11", "3.12"]
+        python-version: ["${{ vars.PYTHON_OLD_MIN }}", "${{ vars.PYTHON_DEFAULT }}", "${{ vars.PYTHON_EXPERIMENTAL }}"]
         lang-var: ["de.utf-8", "jp.utf-8"]
         experimental: [true]
         include:
-          - python-version: "3.10"
+          - python-version: "${{ vars.PYTHON_DEFAULT }}"
             lang-var: "de.utf-8"
             experimental: false
-          - python-version: "3.10"
+          - python-version: "${{ vars.PYTHON_DEFAULT }}"
             lang-var: "jp.utf-8"
             experimental: false
-          - python-version: "3.10"
+          - python-version: "${{ vars.PYTHON_OLD_MIN }}"
             lang-var: "en_US.utf-8"
             experimental: false
-          - python-version: "3.11"
+          - python-version: "${{ vars.PYTHON_OLD_EXTRA }}"
             lang-var: "en_US.utf-8"
             experimental: false
-          - python-version: "3.11"
+          - python-version: "${{ vars.PYTHON_DEFAULT }}"
             lang-var: "en_US.utf-8"
             experimental: false
-          - python-version: "3.12"
+          - python-version: "${{ vars.PYTHON_EXPERIMENTAL }}"
             lang-var: "en_US.utf-8"
-            experimental: false
+            experimental: ${{ (needs.BUILD.environment == 'Experimenting') }}
     outputs:
       bootstrap_status: ${{ steps.bootstrap.outcome }}
     env:
@@ -126,7 +131,7 @@ jobs:
       - name: Summerize Building
         id: sumerize-py-build
         run: |
-          echo "- Building works on python version ${{ matrix.python-version }}" >> $GITHUB_STEP_SUMMARY
+          echo "- [x] Building works on python version ${{ matrix.python-version }}" >> "$GITHUB_STEP_SUMMARY"
         if: ${{ success() }}
         shell: bash
       - name: Run Tests
@@ -136,7 +141,7 @@ jobs:
       - name: Summerize Install
         id: sumerize-user-install
         run: |
-          echo "- User Installing works on python version ${{ matrix.python-version }}" >> $GITHUB_STEP_SUMMARY
+          echo "- [x] User Installing works on python version ${{ matrix.python-version }}" >> "$GITHUB_STEP_SUMMARY"
         if: ${{ success() }}
         shell: bash
       - name: Test Info
@@ -159,6 +164,8 @@ jobs:
     if: ${{ !cancelled() }}
     outputs:
       didBUILD: ${{ steps.check_status.outputs.build_success }}
+      build_ref: ${{ steps.check_status.outputs.build_ref }}
+      build_ref_name: ${{ steps.check_status.outputs.build_ref_name }}
     steps:
       - id: check_status
         run: |
@@ -167,3 +174,5 @@ jobs:
           else
             echo "build_success=false" >> "$GITHUB_OUTPUT"
           fi
+          echo "build_ref=${{ github.ref }}" >> "$GITHUB_OUTPUT"
+          echo "build_ref_name=${{ github.ref_name }}" >> "$GITHUB_OUTPUT"

.github/workflows/CI-DOCS.yml

@@ -1,6 +1,7 @@
 ---
 name: CI-DOCS
-# Continuous Integration workflow for Testing Documentation Building.
+description: "Continuous Integration workflow for Testing Documentation Building."
+run-name: Generate and lint documentation for ${{ github.ref_name }} by @${{ github.actor }}
 #
 # Jobs included:
 # - DOCS: Builds and lints documentation
@@ -35,7 +36,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ["3.10", "3.11", "3.12"]
+        python-version: ["${{ vars.PYTHON_OLD_MIN }}", "${{ vars.PYTHON_DEFAULT }}", "${{ vars.PYTHON_EXPERIMENTAL }}"]
     env:
       OS: ${{ matrix.os }}
       PYTHON_VERSION: ${{ matrix.python-version }}
@@ -44,6 +45,8 @@ jobs:
       DOCS_BUILD_REF: ${{ github.sha }}
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
         with:

.github/workflows/CI-MATs.yml

@@ -1,6 +1,7 @@
 ---
 name: CI-MATs
-# Continuous Integration workflow for Minimal Acceptance Tests (MATs).
+description: "Continuous Integration workflow for Minimal Acceptance Tests (MATs)."
+run-name: Minimal Acceptance Tests for ${{ github.ref_name }} by @${{ github.actor }}
 #
 # This workflow runs after successful completion of CI-BUILD to ensure
 # that the codebase meets minimal acceptance criteria.
@@ -60,6 +61,7 @@ jobs:
     permissions:
       actions: read
       contents: read
+      pull-requests: read
       statuses: write
     needs: check_build
     if: ${{ !cancelled() && (needs.check_build.outputs.should_run == 'true') }}
@@ -71,7 +73,7 @@ jobs:
     timeout-minutes: 8
     strategy:
       matrix:
-        python-version: ["3.10", "3.11", "3.12"]
+        python-version: ["${{ vars.PYTHON_OLD_MIN }}", "${{ vars.PYTHON_DEFAULT }}", "${{ vars.PYTHON_EXPERIMENTAL }}"]
     outputs:
       mats_status: ${{ steps.tests.outcome }}
     env:
@@ -101,7 +103,7 @@ jobs:
       - name: Summerize MATs for python ${{ matrix.python-version }}
         id: sumerize-mats
         run: |
-          echo "- MATS works on python version ${{ matrix.python-version }}" >> $GITHUB_STEP_SUMMARY
+          echo "- [x] MATS succeeded with python version ${{ matrix.python-version }}" >> "$GITHUB_STEP_SUMMARY"
         if: ${{ success() }}
       - name: Post-Clean
         id: post
@@ -111,6 +113,7 @@ jobs:
   MATS_STATUS:
     permissions:
       actions: read
+      pull-requests: read
     needs: [check_build, MATS]
     runs-on: ubuntu-latest
     if: ${{ !cancelled() }}

.github/workflows/Tests.yml

@@ -72,7 +72,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ["3.10", "3.11", "3.12", "3.13"]
+        python-version: ["${{ vars.PYTHON_OLD_MIN }}", "${{ vars.PYTHON_OLD_EXTRA }}", "${{ vars.PYTHON_DEFAULT }}", "${{ vars.PYTHON_EXPERIMENTAL }}"]
     env:
       OS: ${{ matrix.os }}
       PYTHON_VERSION: ${{ matrix.python-version }}
@@ -166,15 +166,15 @@ jobs:
     timeout-minutes: 10
 
     env:
-      PYTHON_VERSION: '3.13'
+      PYTHON_VERSION: "${{ vars.PYTHON_DEFAULT }}"
       LANG: "en_US.utf-8"
 
     steps:
     - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
     - name: Set up Python
       uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
       with:
-        python-version: "3.13"
+        python-version: "${{ vars.PYTHON_DEFAULT }}"
     - name: Install dependencies for python Linters
       run: |
         pip install --upgrade "pip>=24.3.1" "setuptools>=75.0" "wheel>=0.44" "build>=1.2.2";
@@ -210,7 +210,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
-        python-version: ["3.10", "3.11", "3.12", "3.13"]
+        python-version: ["${{ vars.PYTHON_OLD_MIN }}", "${{ vars.PYTHON_OLD_EXTRA }}", "${{ vars.PYTHON_DEFAULT }}", "${{ vars.PYTHON_EXPERIMENTAL }}"]
     env:
       OS: ${{ matrix.os }}
       PYTHON_VERSION: ${{ matrix.python-version }}
@@ -330,7 +330,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
-        python-version: ["3.10", "3.11", "3.12", "3.13"]
+        python-version: ["${{ vars.PYTHON_OLD_MIN }}", "${{ vars.PYTHON_OLD_EXTRA }}", "${{ vars.PYTHON_DEFAULT }}", "${{ vars.PYTHON_EXPERIMENTAL }}"]
     env:
       OS: ${{ matrix.os }}
       PYTHON_VERSION: ${{ matrix.python-version }}
@@ -411,7 +411,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        python-version: ["3.10", "3.11", "3.12", "3.13"]
+        python-version: ["${{ vars.PYTHON_OLD_MIN }}", "${{ vars.PYTHON_OLD_EXTRA }}", "${{ vars.PYTHON_DEFAULT }}", "${{ vars.PYTHON_EXPERIMENTAL }}"]
     env:
       OS: 'ubuntu-latest'
       PYTHON_VERSION: ${{ matrix.python-version }}
@@ -464,7 +464,7 @@ jobs:
 
     env:
       OS: 'ubuntu-latest'
-      PYTHON_VERSION: '3.12'
+      PYTHON_VERSION: "${{ vars.PYTHON_DEFAULT }}"
       LANG: 'en_US.utf-8'
       CODECLIMATE_REPO_TOKEN: ${{ secrets.CODECLIMATE_TOKEN }}
       CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
@@ -475,11 +475,11 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
       with:
-        python-version: "3.12"
+        python-version: "${{ vars.PYTHON_DEFAULT }}"
     - name: Prep Testing Tox
       id: prep-tox
       run: |
-        if [ "$OS" == "ubuntu-latest" ] ; then { sudo apt-get update || true ;} ; wait ; { sudo apt-get install --assume-yes python3.10 python3.11 python3.11-venv || echo "::warning file=.github/workflows/Tests.yml,line=677,endLine=677,title=SKIPPED::SKIP Enhanced TOX Tests." ;} ; wait ; fi
+        if [ "$OS" == "ubuntu-latest" ] ; then { sudo apt-get update || true ;} ; wait ; { sudo apt-get install --assume-yes python3.10 python3.11 python3.11-venv || echo "::warning file=.github/workflows/Tests.yml,line=482,endLine=482,title=SKIPPED::SKIP Enhanced TOX Tests." ;} ; wait ; fi
     - name: Install dependencies for Tox
       run: |
         pip install --upgrade "pip>=24.3.1" "setuptools>=75.0" "wheel>=0.44" "build>=1.2.1";

docs/CI.md

@@ -11,6 +11,55 @@ Continuous integration testing is handled by GitHub Actions and the generous Cir
 [![CodeCov](https://codecov.io/gh/reactive-firewall/multicast/graphs/sunburst.svg)](https://codecov.io/gh/reactive-firewall/multicast)
 [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9458/badge)](https://app.deepsource.com/report/3f7c11ca-c203-44ec-9e01-126078f11660)
 [GHA Metrics](https://github.com/reactive-firewall/multicast/actions/metrics/performance?dateRangeType=DATE_RANGE_TYPE_LAST_90_DAYS)
+![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/reactive-firewall/multicast?utm_source=oss&utm_medium=github&utm_campaign=reactive-firewall%2Fmulticast&labelColor=171717&color=FF570A&link=https%3A%2F%2Fcoderabbit.ai&label=CodeRabbit+Reviews)
+[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/reactive-firewall/multicast.svg)](https://isitmaintained.com/project/reactive-firewall/multicast "Average time to resolve an issue")
+[![Percentage of issues still open](https://isitmaintained.com/badge/open/reactive-firewall/multicast.svg)](https://isitmaintained.com/project/reactive-firewall/multicast "Percentage of issues still open")
+
+## Configurable CI Variables
+
+This section documents environment variables used across CI workflows to ensure consistency and
+simplify maintenance.
+
+### Python Version Variables
+
+To standardize Python version management across all CI workflows, we use a set of environment
+variables defined at the top of each workflow file. This approach centralizes version definitions
+while maintaining separation between workflows, making future updates easier and ensuring
+consistency.
+
+#### Standard Python Version Variables
+
+| Variable | Purpose | Example Value |
+|----------|---------|---------------|
+| `PYTHON_DEFAULT` | The default Python version used for single-version jobs | `"3.12"` |
+| `PYTHON_OLD_MIN` | Oldest/minimum Python version for cross-python portability testing | `"3.10"` |
+| `PYTHON_OLD_EXTRA` | Additional Python version for coverage testing | `"3.11"` |
+| `PYTHON_EXPERIMENTAL` | Future/experimental Python version for optional testing | `"3.13"` |
+
+#### Usage Examples
+
+##### Setting up Python with the default version
+
+```yaml
+- uses: actions/setup-python@v5
+  with:
+    python-version: "${{ vars.PYTHON_DEFAULT }}"
+```
+
+##### Using matrix strategy for multi-version testing
+
+```yaml
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["${{ vars.PYTHON_DEFAULT }}", "${{ vars.PYTHON_EXPERIMENTAL }}"]
+    steps:
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+```
 
 ## Testing
 

tests/check_spelling

@@ -139,6 +139,7 @@ CODESPELL_OPTIONS="--quiet-level=4 --builtin clear,rare,code -L assertIn"
 # Define specific typos to check for (regression tests)
 declare -a SPECIFIC_TYPOS=(
 	"RECCOMENDED:RECOMMENDED"
+	"succedded:succeeded"
 )
 
 function cleanup() {