Stage New CI/CD Improvements.

.github/workflows/CI-BUILD.yml

@@ -0,0 +1,169 @@
+---
+name: CI-BUILD
+# Continuous Integration workflow for building, the project
+#
+# Jobs included:
+# - BUILD: Ensures the project compiles correctly
+# - BOOTSTRAP: Tests installation across Python versions and locales
+#
+# Required Secrets:
+# NONE
+
+on:  # yamllint disable-line rule:truthy
+  push:
+    branches: ["**"]  # matches any branch
+    tags: ["v*"]
+
+# Declare default permissions as none.
+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' }}
+
+jobs:
+  BUILD:
+    permissions:
+      actions: read
+      contents: read
+      statuses: write
+      packages: none
+      pull-requests: read
+      security-events: none
+    if: ${{ !cancelled() && (github.repository == 'reactive-firewall/multicast') }}
+    runs-on: ubuntu-latest
+    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' }}
+    defaults:
+      run:
+        shell: bash
+    env:
+      LANG: "en_US.UTF-8"
+    outputs:
+      build_status: ${{ steps.build.outcome }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
+        with:
+          python-version: "3.12"
+      - name: Pre-Clean
+        id: clean
+        run: make -j1 -f Makefile purge 2>/dev/null || true
+      - name: Test Build
+        id: build
+        run: make -j1 -f Makefile build
+      - name: Post-Clean
+        id: post
+        run: make -j1 -f Makefile purge || true
+
+  BOOTSTRAP:
+    permissions:
+      actions: read
+      contents: read
+      statuses: write
+      packages: none
+      pull-requests: read
+      security-events: none
+    if: ${{ !cancelled() }}
+    needs: BUILD
+    runs-on: ubuntu-latest
+    environment: ${{ needs.BUILD.environment }}
+    defaults:
+      run:
+        shell: bash
+    timeout-minutes: 5
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+        lang-var: ["de.utf-8", "jp.utf-8"]
+        experimental: [true]
+        include:
+          - python-version: "3.10"
+            lang-var: "de.utf-8"
+            experimental: false
+          - python-version: "3.10"
+            lang-var: "jp.utf-8"
+            experimental: false
+          - python-version: "3.10"
+            lang-var: "en_US.utf-8"
+            experimental: false
+          - python-version: "3.11"
+            lang-var: "en_US.utf-8"
+            experimental: false
+          - python-version: "3.11"
+            lang-var: "en_US.utf-8"
+            experimental: false
+          - python-version: "3.12"
+            lang-var: "en_US.utf-8"
+            experimental: false
+    outputs:
+      bootstrap_status: ${{ steps.bootstrap.outcome }}
+    env:
+      PYTHON_VERSION: ${{ matrix.python-version }}
+      LANG: ${{ matrix.lang-var }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
+      - name: Set up Python
+        uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Set up dependencies
+        run: |
+          pip install --upgrade "pip>=24.3.1" "setuptools>=75.0" "wheel>=0.44" "build>=1.2.1";
+          pip install -r ./requirements.txt ;
+      - name: Pre-build
+        id: bootstrap
+        run: |
+          make -j1 -f Makefile clean || true ;
+          make -j1 -f Makefile build ;
+        shell: bash
+      - name: Summerize Building
+        id: sumerize-py-build
+        run: |
+          echo "- Building works on python version ${{ matrix.python-version }}" >> $GITHUB_STEP_SUMMARY
+        if: ${{ success() }}
+        shell: bash
+      - name: Run Tests
+        id: test-user-install
+        run: make -j1 -f Makefile user-install ;
+        shell: bash
+      - name: Summerize Install
+        id: sumerize-user-install
+        run: |
+          echo "- User Installing works on python version ${{ matrix.python-version }}" >> $GITHUB_STEP_SUMMARY
+        if: ${{ success() }}
+        shell: bash
+      - name: Test Info
+        id: test-info
+        run: python -m setup --name --version --license || true ;
+      - name: Post-Clean
+        id: post-bootstrap
+        run: |
+          make -j1 -f Makefile purge || true ;
+          make -j1 -f Makefile clean || true ;
+        if: ${{ always() }}
+        shell: bash
+
+  BUILD_STATUS:
+    permissions:
+      actions: read
+      pull-requests: read
+    needs: [BUILD, BOOTSTRAP]
+    runs-on: ubuntu-latest
+    if: ${{ !cancelled() }}
+    outputs:
+      didBUILD: ${{ steps.check_status.outputs.build_success }}
+    steps:
+      - id: check_status
+        run: |
+          if [[ "${{ needs.BUILD.result }}" == "success" && "${{ needs.BOOTSTRAP.result }}" == "success" ]]; then
+            echo "build_success=true" >> $GITHUB_OUTPUT
+          else
+            echo "build_success=false" >> $GITHUB_OUTPUT
+          fi

.github/workflows/CI-DOCS.yml

@@ -0,0 +1,86 @@
+---
+name: CI-DOCS
+# Continuous Integration workflow for Testing Documentation Building.
+#
+# Jobs included:
+# - DOCS: Builds and lints documentation
+#
+# Required Secrets:
+# - DOCS_BUILD_REF: Automatic
+
+permissions: {}
+
+on:  # yamllint disable-line rule:truthy
+  push:
+    branches: ["main", "master", "stable"]
+    tags: ["v*"]
+  pull_request:
+    types: [opened, reopened, ready_for_review]
+    branches: ["feature-*", "patch-*", "HOTFIX-*"]
+  pull_request_target:
+    types: [opened, edited, reopened, ready_for_review]
+    branches: ["main", "master", "stable"]
+
+jobs:
+  DOCS:
+    permissions:
+      actions: read
+      contents: read
+      statuses: write
+      packages: none
+      pull-requests: read
+      security-events: none
+    environment: ${{ (github.ref == 'refs/heads/stable' || startsWith(github.ref, 'refs/tags/v')) && 'Deployment' || (github.ref == 'refs/heads/master') && 'Testing' || 'Experimenting' }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.10", "3.11", "3.12"]
+    env:
+      OS: ${{ matrix.os }}
+      PYTHON_VERSION: ${{ matrix.python-version }}
+      LANG: "en_US.utf-8"
+      LC_CTYPE: "en_US.utf-8"
+      DOCS_BUILD_REF: ${{ github.sha }}
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Fix braindead windows ${{ matrix.python-version }} on ${{ matrix.os }}
+        if: ${{ !cancelled() && runner.os == 'Windows' }}
+        run: python -m pip install --upgrade pip
+      - name: Install dependencies for python ${{ matrix.python-version }} on ${{ matrix.os }}
+        run: |
+          pip install --upgrade "pip>=24.3.1" "setuptools>=75.0" "wheel>=0.44" "build>=1.2.1";
+          pip install -r ./requirements.txt ;
+          pip install -r ./tests/requirements.txt || true ;
+      - name: Pre-Clean
+        id: clean-prep
+        run: make -j1 -f Makefile clean ;
+      - name: Pre-build for Python ${{ matrix.python-version }} on ${{ matrix.os }}
+        run: make -j1 -f Makefile build ;
+        if: ${{ success() }}
+      - name: Generate documentation with py${{ matrix.python-version }} on ${{ matrix.os }}
+        run: make -j1 -f Makefile build-docs 2>&1 >> $GITHUB_STEP_SUMMARY ;
+        if: ${{ !cancelled() }}
+      - name: Lint documentation
+        run: |
+          pip install --upgrade sphinx-lint
+          sphinx-lint docs/ 2>&1 >> $GITHUB_STEP_SUMMARY || true ;
+        if: ${{ !cancelled() }}
+      - name: Upload Docs Artifact with Python ${{ matrix.python-version }} on ${{ matrix.os }}
+        uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
+        with:
+          name: Multicast-Documentation-${{ github.sha }}-${{ matrix.os }}-${{ matrix.python-version }}
+          path: ./docs/www/
+          if-no-files-found: ignore
+      - name: Post-purge
+        id: post-uninstall
+        run: make -j1 -f Makefile purge || true ;
+        if: ${{ !cancelled() }}
+      - name: Post-Clean
+        id: post-end
+        run: make -j1 -f Makefile clean || true ;
+        if: ${{ !cancelled() }}

.github/workflows/CI-MATs.yml

@@ -0,0 +1,117 @@
+---
+name: CI-MATs
+# Continuous Integration workflow for Minimal Acceptance Tests.
+#
+# Jobs included:
+# - MATS: Runs Machine Acceptance Tests
+#
+# Required Secrets:
+# NONE
+
+on:  # yamllint disable-line rule:truthy
+  workflow_run:
+    workflows: ["CI-BUILD"]
+    types:
+      - completed
+
+# Declare default permissions as none.
+permissions: {}
+
+jobs:
+  check_build:
+    permissions:
+      actions: read
+      pull-requests: read
+      checks: write
+    runs-on: ubuntu-latest
+    env:
+      GH_TOKEN: ${{ github.token }}
+    outputs:
+      should_run: ${{ steps.check.outputs.should_run }}
+      build_environment: ${{ steps.get_env.outputs.environment }}
+    steps:
+      - id: check
+        run: |
+          if [[ "${{ github.event.workflow_run.conclusion }}" == "success" ]]; then
+            echo "should_run=true" >> $GITHUB_OUTPUT
+          else
+            echo "should_run=false" >> $GITHUB_OUTPUT
+          fi
+      - id: get_env
+        run: |
+          ENV_VALUE=$(gh api "${{ github.event.workflow_run.artifacts_url }}" --jq '.environment')
+          if [[ -n "$ENV_VALUE" ]]; then
+            echo "environment=$ENV_VALUE" >> $GITHUB_OUTPUT
+          else
+            echo "environment=Experimenting" >> $GITHUB_OUTPUT  # Default fallback
+          fi
+
+  MATS:
+    permissions:
+      actions: read
+      contents: read
+      statuses: write
+    needs: check_build
+    if: ${{ !cancelled() && (needs.check_build.outputs.should_run == 'true') }}
+    runs-on: ubuntu-latest
+    environment: ${{ needs.check_build.outputs.build_environment }}
+    defaults:
+      run:
+        shell: bash
+    timeout-minutes: 8
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+    outputs:
+      mats_status: ${{ steps.tests.outcome }}
+    env:
+      PYTHON_VERSION: ${{ matrix.python-version }}
+      LANG: "en_US.utf-8"
+    steps:
+      - name: Checkout repository
+        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:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies for ${{ matrix.python-version }}
+        run: |
+          pip install --upgrade "pip>=24.3.1" "setuptools>=75.0" "wheel>=0.44" "build>=1.2.1";
+          pip install -r ./requirements.txt ;
+          pip install -r ./tests/requirements.txt || true ;
+          pip install --upgrade -r ./docs/requirements.txt || true ;
+      - name: Pre-Clean
+        id: clean
+        run: make -j1 -f Makefile clean || true ;
+      - name: Run Tests for python ${{ matrix.python-version }}
+        id: tests
+        run: make -j1 -f Makefile test ;
+      - name: Summerize MATs for python ${{ matrix.python-version }}
+        id: sumerize-mats
+        run: |
+          echo "- MATS works on python version ${{ matrix.python-version }}" >> $GITHUB_STEP_SUMMARY
+        if: ${{ success() }}
+      - name: Post-Clean
+        id: post
+        run: make -j1 -f Makefile clean || true ;
+        if: ${{ always() }}
+
+  MATS_STATUS:
+    permissions:
+      actions: read
+    needs: [check_build, MATS]
+    runs-on: ubuntu-latest
+    if: ${{ !cancelled() }}
+    outputs:
+      passedMATs: ${{ steps.check_status.outputs.mats_success }}
+      didBUILD: ${{ needs.check_build.outputs.should_run }}
+    steps:
+      - id: check_status
+        run: |
+          if [[ "${{ needs.MATS.result }}" == "success" ]]; then
+            echo "mats_success=true" >> $GITHUB_OUTPUT
+          else
+            echo "mats_success=false" >> $GITHUB_OUTPUT
+          fi

.github/workflows/Labeler.yml

@@ -18,6 +18,6 @@ jobs:
       security-events: none
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/labeler@v5
+    - uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9 # v5.0.0
       with:
         repo-token: "${{ secrets.GITHUB_TOKEN }}"