Merge pull request #420 from ugorji/devel

Merging v1.3 development changes into master

Author: ugorji

.github/workflows/test.yml

@@ -2,17 +2,18 @@ name: Build and Test go-codec
 on:
   workflow_dispatch: {}
   push:
-    branches: [ master ]
-    paths: [ '**.go' ]
+    branches: [ master, devel ]
+    paths: [ '**.go', '.github/workflows/*' ]
   pull_request:
     branches: [ master ]
-    paths: [ '**.go' ]
+    paths: [ '**.go', '.github/workflows/*' ]
 jobs:
-  tests:
+  master_tests:
+    if: github.ref_name == 'master'
     strategy:
       fail-fast: false
       matrix:
-        go: [ '1.19', '1.17', '1.11', '1.20.0-rc.1', '1.24' ]
+        go: [ '1.24', '1.19', '1.17', '1.11' ]
         arch: [ amd64 ]
         os: [ ubuntu-latest ]
         include:
@@ -24,7 +25,7 @@ jobs:
       GO111MODULE: 'on'
       COVER_GO_VERSION: '1.19'
       GOARCH: ${{ matrix.arch }}
-    name: go ${{ matrix.go }} on ${{ matrix.arch }}
+    name: go ${{ matrix.go }} on ${{ matrix.arch }} at branch ${{ github.ref_name }}
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-go@v3
@@ -35,12 +36,47 @@ jobs:
         run: |
           cd codec
           go mod edit -droprequire github.com/ugorji/go
-          t=( "" "safe" "notfastpath" "codecgen" )
-          for i in "${t[@]}"; do go test "-tags=alltests ${i}" "-run=Suite" "-coverprofile=coverage.${{ matrix.go }}.${{ matrix.arch }}.${i}.txt"; done
+          t=( "" "safe" "notfastpath" "notmono" )
+          for i in "${t[@]}"; do
+          go test "-tags=alltests codec.nobench ${i}" "-run=Suite" "-coverprofile=coverage.${{ matrix.go }}.${{ matrix.arch }}.${i}.txt"
+          done
       - uses: codecov/codecov-action@v3
         if: matrix.go == env.COVER_GO_VERSION
         with:
           directory: ./codec
+  devel_tests:
+    if: github.ref_name == 'devel'
+    strategy:
+      fail-fast: false
+      matrix:
+        go: [ '1.24', '1.22' ]
+        arch: [ amd64 ]
+        os: [ ubuntu-latest ]
+        include:
+          - go: '1.22'
+            arch: '386'
+            os: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    env:
+      GO111MODULE: 'on'
+      GOARCH: ${{ matrix.arch }}
+    name: go ${{ matrix.go }} on ${{ matrix.arch }} at branch ${{ github.ref_name }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go }}
+      - shell: bash
+        run: cd codec; go get github.com/google/go-cmp/cmp
+      - name: Run tests
+        shell: bash
+        run: |
+          cd codec
+          go mod edit -droprequire github.com/ugorji/go
+          t=( "" "safe" "notfastpath" "notmono" )
+          for i in "${t[@]}"; do
+          go test "-tags=alltests codec.nobench ${i}" "-run=Suite" "-coverprofile=coverage.${{ matrix.go }}.${{ matrix.arch }}.${i}.txt"
+          done
 
 
 # No need to go get, as github knows its working out of this folder.
@@ -68,8 +104,6 @@ jobs:
 # Now is a good time to remove that requirements cycle.
 #
 #
-#
-#
 # --- SCRATCH ---
 # coverage:
 #   if: ${{ always() }}

README.md

@@ -10,30 +10,19 @@
 This repository contains the `go-codec` library, the `codecgen` tool and
 benchmarks for comparing against other libraries.
 
-This is a High Performance, Feature-Rich Idiomatic Go 1.4+ codec/encoding library
+This is a High Performance, Feature-Rich Idiomatic Go 1.20+ codec/encoding library
 for binary and text formats: binc, msgpack, cbor, json and simple.
 
-It fully supports the legacy `GOPATH` and the new `go modules` modes.
+It supports generics and monomorphization, based on build tags set.
 
 ## Code Organization and Module Support
 
-This repository consists of 4 modules:
+This repository consists of 1 module:
 
 - `github.com/ugorji/go/codec` [README](codec/README.md)
-- `github.com/ugorji/go/codec/codecgen` (requires `github.com/ugorji/go/codec`) [README](codec/codecgen/README.md)
-- `github.com/ugorji/go/codec/bench` (requires `github.com/ugorji/go/codec`) [README](codec/bench/README.md)
-- `github.com/ugorji/go` (requires `github.com/ugorji/go/codec`)
-
-For encoding and decoding, the `github.com/ugorji/go/codec` module is sufficient.
 
 To install:
 
 ```
 go get github.com/ugorji/go/codec
 ```
-
-The other modules exist for specific uses, and all require `github.com/ugorji/go/codec`
-
-- `github.com/ugorji/go/codec/codecgen` generates high performance static encoders/decoders for given types
-- `github.com/ugorji/go/codec/bench` benchmarks codec against other popular go libraries
-- `github.com/ugorji/go` is here for [historical compatibility reasons, as modules was initially introduced only at repo root](https://github.com/ugorji/go/issues/299)