[CONFIG] Apply changes as found in review (- WIP PR #402 -)

 * these changes are related to cleaning up GHI #338

Changes in file .github/actions/run-minimal-acceptance-tests/action.yml:
 * cleaned up a little
 * related work

Changes in file .github/actions/setup-py-reqs/action.yml:
 * cleaned up a bunch and added comments
 * related work

Changes in file .github/workflows/CI-DOCS.yml:
 * fixed a few missed values
 * related work

Changes in file .github/workflows/Tests.yml:
 * related work

Changes in file tests/check_spelling:
 * related work

Author: reactive-firewall

.github/actions/run-minimal-acceptance-tests/action.yml

@@ -91,7 +91,7 @@ runs:
         PYTHON_VERSION_INPUT: ${{ inputs.python-version }}
       shell: bash
       run: |
-        if [[ -z $PYTHON_VERSION_INPUT ]]; then
+        if [[ -n $PYTHON_VERSION_INPUT ]]; then
           printf "python-version=%s\n" "${PYTHON_VERSION_INPUT}" >> "$GITHUB_OUTPUT"
           PYTHON_VERSION=${PYTHON_VERSION_INPUT}
         else

.github/actions/setup-py-reqs/action.yml

@@ -76,7 +76,7 @@ runs:
         PYTHON_VERSION_INPUT: ${{ inputs.python-version }}
       shell: bash
       run: |
-        if [[ -z $PYTHON_VERSION_INPUT ]]; then
+        if [[ -n $PYTHON_VERSION_INPUT ]]; then
           printf "python-version=%s\n" "${PYTHON_VERSION_INPUT}" >> "$GITHUB_OUTPUT"
           PYTHON_VERSION=${PYTHON_VERSION_INPUT}
         else
@@ -88,8 +88,13 @@ runs:
       if: ${{ !cancelled() }}
       shell: bash
       run: |
-        printf "artifact-name=%s\n" multicast-deps-${{ steps.output_sha.outputs.sha }}-part-$(uuidgen) >> "$GITHUB_OUTPUT"
-        printf "%s\n" "DEPS_STEP_SUMMARY=Dependencies-Summary-Artifact-${PYTHON_VERSION}.txt" >> "$GITHUB_ENV"
+        if [[ ${{ runner.os }} != 'Windows' ]] ; then
+          printf "artifact-name=%s\n" multicast-integration-${BUILD_SHA}-part-$(uuidgen) >> "$GITHUB_OUTPUT"
+        else
+          printf "artifact-name=%s" multicast-integration-${BUILD_SHA}-part- >> "$GITHUB_OUTPUT"
+          printf "%04x%04x-%04x-%04x-%04x-%04x%04x%04x\n" $RANDOM $RANDOM $RANDOM $(($RANDOM & 0x0fff | 0x4000)) $(($RANDOM & 0x3fff | 0x8000)) $RANDOM $RANDOM $RANDOM >> "$GITHUB_OUTPUT"
+        fi
+        printf "%s\n" "DEPS_STEP_SUMMARY=Dependencies-Summary-Artifact-${{ runner.os }}-${PYTHON_VERSION}.txt" >> "$GITHUB_ENV"
     - name: "Install Build Dependencies"
       id: install_build_requirements
       if: ${{ !cancelled() }}
@@ -121,30 +126,42 @@ runs:
       run: |
         if [[ "${{ steps.install_build_requirements.outcome }}" != "failure" ]] ; then
           if [[ ( -r requirements.txt ) ]] ; then
+            # Initialize result as success b/c nothing failed ... yet
             THE_RESULT="success"
           else
+            # Initialize result as skipped b/c nothing could be done without requirements.txt
             THE_RESULT="skipped"
           fi
         else
+          # Initialize result as failure right away
           THE_RESULT="failure"
         fi
         if [[ "${{ steps.install_test_requirements.outcome }}" == "success" && "${THE_RESULT}" == "success" ]] ; then
+          # keep result as success b/c something succeeded and nothing failed ... yet
           THE_RESULT="success"
         else
+          # check for actual failure
           if [[ "${{ steps.install_test_requirements.outcome }}" == "failure" ]] ; then
+             # force result as failure b/c something failed
              THE_RESULT="failure"
           fi
         fi
         if [[ "${{ steps.install_docs_requirements.outcome }}" == "success" && "${THE_RESULT}" == "success" ]] ; then
+          # keep result as success b/c something succeeded and nothing failed ... at all
           THE_RESULT="success"
         else
+          # check for actual failure
           if [[ "${{ steps.install_docs_requirements.outcome }}" == "failure" ]] ; then
+             # force result as failure b/c something failed
              THE_RESULT="failure"
           fi
         fi
+        # hint to help with debugging
+        printf "::debug:: %s\n" "The result of dependency evaluation: ${THE_RESULT}"
         if [[ "${THE_RESULT}" == "success" ]] ; then
           exit 0
         else
+          # exit as failure b/c either a soft-fail (skip/cancelled/etc.) or actual failure
           exit 1
         fi
     - name: "Summarize DEPs"
@@ -191,6 +208,7 @@ runs:
           printf "%s\n" "DEPS summary files found:"
           printf "%s\n" "$FILES"
           mkdir DEPS || :
+          printf "%s\n" "$FILES" | xargs -I{} mv -f "{}" "DEPS/{}" || :
           # Replace line breaks with spaces for GitHub Action Output
           FILES="${FILES//$'\n'/ }"
           printf "%s\n" "files=$FILES" >> "$GITHUB_OUTPUT"

.github/workflows/CI-DOCS.yml

@@ -217,7 +217,7 @@ jobs:
           BUILD_SHA: ${{ needs.check_mats.outputs.build_sha }}
           DOCUMENTATION_COMMENT_BODY: '${{ github.workspace }}/DOCUMENTATION-Summary-Artifact.txt'
         run: |
-          if [[ "${{ needs.COVERAGE.outputs.coverage_outcome }}" == "success" ]]; then
+          if [[ "${{ needs.DOCS.outputs.docs_outcome }}" == "success" ]]; then
             printf "%s\n\n" "# :book: Documentation Summary" > "${DOCUMENTATION_COMMENT_BODY}"
             printf "%s\n" "  * :ballot_box_with_check: Generating Documentation Passed" >> "${DOCUMENTATION_COMMENT_BODY}"
             printf "%s\n" "documentation_success=true" >> "$GITHUB_OUTPUT"
@@ -268,7 +268,7 @@ jobs:
           check-id: ${{ needs.check_mats.outputs.check_id }}
           title: "Documentation Testing"
           status: 'completed'
-          conclusion: ${{ needs.COVERAGE.outputs.coverage_outcome }}
+          conclusion: ${{ needs.DOCS.outputs.docs_outcome }}
           summary: ${{ steps.report_status.outputs.docs_summary }}
           text: ${{ steps.report_status.outputs.docs_text }}
           sha: ${{ needs.check_mats.outputs.build_sha }}

.github/workflows/Tests.yml

@@ -389,7 +389,7 @@ jobs:
         SCRIPT_NAME: ".github/actions/run-coverage-tests/action.yml"
       shell: bash
       run: |
-        FILES=$(git ls-files -o --exclude-standard -- ${{ env.MATS_MATCH_PATTERN }} )
+        FILES=$(git ls-files -o --exclude-standard -- ${{ env.COV_MATCH_PATTERN }} )
         if [ -z "$FILES" ]; then
           printf "::warning file=%s:: %s\n" "${SCRIPT_NAME}" "No summary files found."
           printf "%s\n" "files=" >> "$GITHUB_OUTPUT"
@@ -797,7 +797,7 @@ jobs:
         persist-credentials: false
         ref: ${{ needs.check_mats.outputs.build_sha }}
         sparse-checkout: '.github/actions/checkout-and-rebuild'
-    - name: Checkout repository for Style with ${{ matrix.python-version }}
+    - name: "Checkout repository for Style with ${{ vars.PYTHON_DEFAULT }}"
       id: fetch-build
       uses: ./.github/actions/checkout-and-rebuild
       with:
@@ -860,7 +860,7 @@ jobs:
       CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
     outputs:
       integration_outcome: ${{ steps.integration_outcome.outcome }}
-      integration_test_outcome: ${{ steps.integration_tests.integration_test_outcome }}
+      integration_test_outcome: ${{ steps.integration_tests.outputs.integration_test_outcome }}
       integration_pytest_outcome: ${{ steps.integration-pytest.outcome }}
       integration_doctest_outcome: ${{ steps.integration-doctests.outcome }}
       integration_function_outcome: ${{ steps.integration-main.outcome }}
@@ -1231,15 +1231,15 @@ jobs:
           TESTS_COMMENT_BODY: '${{ github.workspace }}/Integration-Summary-Artifact.txt'
         run: |
           if [[ "${{ needs.INTEGRATION.outputs.integration_outcome }}" == "success" ]]; then
-            printf "%s\n" "# :open_umbrella: Code Coverage Summary" > "${TESTS_COMMENT_BODY}"
-            printf "%s\n" "coverage_success=true" >> "$GITHUB_OUTPUT"
-            printf "%s\n" "tests_summary=Coverage Tests Passed" >> "$GITHUB_OUTPUT"
+            printf "%s\n" "# :clipboard: Testing Summary" > "${TESTS_COMMENT_BODY}"
+            printf "%s\n" "test_success=true" >> "$GITHUB_OUTPUT"
+            printf "%s\n" "tests_summary=CI Tests Passed" >> "$GITHUB_OUTPUT"
           else
             printf "%s\n\n" "# Known flaws." > "${TESTS_COMMENT_BODY}"
             printf "%s\n" "> [!WARNING]" >> "${TESTS_COMMENT_BODY}"
             printf "%s\n\n" "> This commit has known flaws. Each commit is subject to minimal acceptance testing, and then select commits are subject to extra testing to evaluate release candidates; This commit has been deemed _not ready_ for release." >> "${TESTS_COMMENT_BODY}"
-            printf "%s\n" "coverage_success=false" >> "$GITHUB_OUTPUT"
-            printf "%s\n" "tests_summary=Coverage Tests Unsuccessful" >> "$GITHUB_OUTPUT"
+            printf "%s\n" "test_success=false" >> "$GITHUB_OUTPUT"
+            printf "%s\n" "tests_summary=Some Tests Unsuccessful" >> "$GITHUB_OUTPUT"
           fi
           for OS_TAG in "Linux" "macOS" "Windows" ; do
             for TYPE_TAG in "Integration" ; do
@@ -1273,8 +1273,8 @@ jobs:
           persist-credentials: false
           ref: ${{ needs.check_mats.outputs.build_sha }}
           sparse-checkout: '.github/actions/check-control'
-      - name: "Compleate Tests GitHub Check"
-        id: compleate_tests
+      - name: "Complete Tests GitHub Check"
+        id: complete_tests
         if: ${{ (github.repository == 'reactive-firewall/multicast') && always() }}
         uses: ./.github/actions/check-control
         with:

tests/check_spelling

@@ -154,6 +154,7 @@ declare -a SPECIFIC_TYPOS=(
 	"boundry:boundary"  # from #384
 	"rappidly:rapidly"  # from #392
 	"compleated:completed"  # from #338
+	"compleate:complete"  # from #402
 )
 
 function cleanup() {