fixup

Signed-off-by: Frederic BIDON <fredbi@yahoo.com>

Author: fredbi

.github/workflows/go-test.yml

@@ -28,8 +28,8 @@ jobs:
         with:
           version: latest
           only-new-issues: true
-          skip-cache: true
-      - name: Linting complete
+          skip-cache: false
+      - name: Linting complete  # <- report summary when we have good news to report
         run: |
           echo "### Your changes to the go code look good. 👍" >> $GITHUB_STEP_SUMMARY
           echo "" >> $GITHUB_STEP_SUMMARY
@@ -39,7 +39,7 @@ jobs:
   unit_tests:
     name: Unit tests
     # description: |
-    # Run go unit tests run 6x: linux, mac & windows on the 2 latest go versions.
+    # Run go unit tests run x6: linux, mac & windows on the 2 latest go versions.
     #
     # Run tests with the -race flag.
     #
@@ -56,16 +56,15 @@ jobs:
 
     strategy:
       matrix:
-        #os: [ ubuntu-latest, macos-latest, windows-latest ]
-        os: [ ubuntu-latest ]
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
         go_version: ['oldstable', 'stable' ]
 
     steps:
     - uses: actions/setup-go@v5
       with:
         go-version: '${{ matrix.go_version }}'
         check-latest: true
-        cache: true
+        cache: true # <- cache key is go.sum
 
     - uses: actions/checkout@v5
 
@@ -114,19 +113,21 @@ jobs:
     steps:
       - name: Tests complete
         run: |
-          echo "All tests completed. 👍" >> $GITHUB_STEP_SUMMARY
+          echo "### All tests completed. 👍" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "> ℹ️ INFO: we run unit tests in 6 different configurations of OS and go version." >> $GITHUB_STEP_SUMMARY
+          echo "> At this moment, we don't run architecture-specific test runs" >> $GITHUB_STEP_SUMMARY
           echo "" >> $GITHUB_STEP_SUMMARY
           echo "| go version | OS | Result |" >> $GITHUB_STEP_SUMMARY
           echo "|------------|----|--------|" >> $GITHUB_STEP_SUMMARY
           declare -a lines 
           eval "lines=($(echo $test_result|tr ',' ' '))"
           for line in "${lines[@]}";do echo "${line}" ; done >> $GITHUB_STEP_SUMMARY
-          cat $GITHUB_STEP_SUMMARY
 
   some_failed_tests:
     name: Some tests have failed
     # description: |
-    # This job is only here to report a summary of failed tests in the github actions UI
+    # This job is only here to report a summary of failed tests in the github actions UI.
     needs: [ unit_tests ]     # <- requires all unit_tests jobs to be completed, but not necessarily successfully.
     if: ${{ needs.unit_tests.result == 'failure' }}
     env:

README.md

@@ -6,3 +6,28 @@ Common CI workflows and setup for go-openapi repos.
 * shared dependabot config
 
 NOTE: at this moment, it is difficult to share the golangci-lint config, so that one is not shared yet.
+
+## Motivation
+
+It took a while, but we eventually managed to align all checks, tests and dependabot rules declared in the
+family of go-openapi repos. 
+
+Now we'd like to be able to maintain, enrich and improve these checks without worrying too much about
+the burden to replicate it about a dozen times.
+
+## Contemplated enhancements
+
+* [] enrich github actions UI with a job summary
+* [] addition go.sum cache for tests
+* [] share mono repo workflows (see github.com/go-openapi/swag/.github/workflows) 
+* [] manage somehow to share golangci config (with local merge)
+* [] manage somehow to share / replicate dependabot config
+* [] add markdown linting for docs
+* [] add spellcheck for docs (and code?)
+* [] use non-blocking, scheduled, proactive full linting to check for the impact of new linters, new go versions etc
+* [] (possibility) take over hugo & doc gen part from go-swagger
+* [] (possibility) take over release part from go-swagger
+* [] produce hugo github page with all latest tagged versions (incl. mono repo)
+* [] add bot to filter PRs, issues
+* [] check with github API that all repo settings (branch protection rules, etc) are identical
+* [] comment PRs and issues

sample/sample_test.go

@@ -1,11 +1,18 @@
 package sample
 
 import (
+	"runtime"
 	"testing"
 
 	"github.com/stretchr/testify/require"
 )
 
 func TestSample(t *testing.T) {
+	if runtime.GOOS == "windows" {
+		require.Equal(t, 0, Sample()) // make the test fail on windows
+
+		return
+	}
+
 	require.Equal(t, 1, Sample())
 }