[pull] master from ugorji:master

.github/workflows/test.yml

@@ -0,0 +1,84 @@
+name: Build and Test go-codec
+on:
+  workflow_dispatch: {}
+  push:
+    branches: [ master ]
+    paths: [ '**.go' ]
+  pull_request:
+    branches: [ master ]
+    paths: [ '**.go' ]
+jobs:
+  tests:
+    strategy:
+      fail-fast: false
+      matrix:
+        go: [ '1.19', '1.17', '1.11', '1.20.0-rc.1' ]
+        arch: [ amd64 ]
+        os: [ ubuntu-latest ]
+        include:
+          - go: '1.19'
+            arch: '386'
+            os: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    env:
+      GO111MODULE: 'on'
+      COVER_GO_VERSION: '1.19'
+      GOARCH: ${{ matrix.arch }}
+    name: go ${{ matrix.go }} on ${{ matrix.arch }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go }}
+      - name: Run tests
+        shell: bash
+        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
+      - uses: codecov/codecov-action@v3
+        if: matrix.go == env.COVER_GO_VERSION
+        with:
+          directory: ./codec
+
+
+# No need to go get, as github knows its working out of this folder.
+#
+# Most of our code is the same since go1.12; before that we selectively compile files using build constraints.
+#
+# We test against the following go releases
+# - latest production release
+# - 2 releases before that
+# - an archive version (go 1.11)
+# - and a beta/rc of development release (so github can just download an archive of it and use)
+#
+# Pre-release versions must use semver e.g. as of 20221220, it's '1.20.0-rc.1' 
+# TODO: add this back once we resolve the issue with go-codec failing on development branch.
+#
+# We test amd64 on all releases, and i386 (32-bit) on last production release.
+#
+# We previously had each tag be its own matrix, but that exploded the number of runs.
+# Instead, since the environment is consistent, we just use a bash script to run through all
+# the tags for that run.
+#
+# Finally, we do a go mod edit -droprequire github.com/ugorji/go to circumvent the "missing go.sum entry" error.
+# We put a requirements cycle with github.com/ugorji/go to allow folks requiring .../ugorji/go in 2019 to work ok.
+# Now, everyone should have updated to a go-codec version >= 1.17 or preferably >= 1.2.0.
+# Now is a good time to remove that requirements cycle.
+#
+#
+#
+#
+# --- SCRATCH ---
+# coverage:
+#   if: ${{ always() }}
+#   needs: [ tests]
+#   steps:
+#     - uses: codecov/codecov-action@v3
+#       directory: ./codec
+#
+# steps:
+#   - uses: actions/checkout@v3
+#     with:
+#       fetch-depth: 0 # required for new-from-rev option in .golangci.yml

FAQ.md

@@ -57,6 +57,20 @@ Fixing `ambiguous import` failure is now as simple as running
 go get -u github.com/ugorji/go/codec@latest
 ```
 
+### Removing requirements cycle in v1.2.8
+
+Unfortunately, due to the requirements cycle noted above, we cannot create a
+valid `go.sum` until after the git version tags have been created. This is why
+a `go.sum` has not been distributed with these 2 modules above.
+
+To fix that, starting with codec `v1.2.8`, we will remove the requirements cycle.
+`github.com/ugorji/go/` will require `github.com/ugorji/go/codec`
+but not vice versa. It has been over 3 years since we released `v1.1.7` (in July 2019)
+with the requirements cycle to accomodate folks with an older version of
+the `github.com/ugorji/go` module. We believe most folks now depend
+either directly on the newer `github.com/ugorji/go/codec` module, or
+on a newer `github.com/ugorji/go` module.
+
 ## Running on GCCGO
 
 You can use [gccgo](https://gcc.gnu.org/onlinedocs/gccgo/) [1](https://golang.org/doc/install/gccgo)

README.md

@@ -1,7 +1,7 @@
 [![Sourcegraph](https://sourcegraph.com/github.com/ugorji/go/-/badge.svg?v=4)](https://sourcegraph.com/github.com/ugorji/go/-/tree/codec?badge)
-[![Build Status](https://travis-ci.org/ugorji/go.svg?branch=master)](https://travis-ci.org/ugorji/go)
+[![Build and Test go-codec](https://github.com/ugorji/go/actions/workflows/test.yml/badge.svg)](https://github.com/ugorji/go/actions/workflows/test.yml)
 [![codecov](https://codecov.io/gh/ugorji/go/branch/master/graph/badge.svg?v=4)](https://codecov.io/gh/ugorji/go)
-[![PkgGoDev](https://pkg.go.dev/badge/github.com/ugorji/go/codec)](https://pkg.go.dev/github.com/ugorji/go/codec)
+[![Go Reference](https://pkg.go.dev/badge/github.com/ugorji/go/codec.svg)](https://pkg.go.dev/github.com/ugorji/go/codec)
 [![rcard](https://goreportcard.com/badge/github.com/ugorji/go/codec?v=4)](https://goreportcard.com/report/github.com/ugorji/go/codec)
 [![License](http://img.shields.io/badge/license-mit-blue.svg?style=flat-square)](https://raw.githubusercontent.com/ugorji/go/master/LICENSE)
 
@@ -19,10 +19,10 @@ It fully supports the legacy `GOPATH` and the new `go modules` modes.
 
 This repository consists of 4 modules:
 
-- `github.com/ugorji/go` (requires `github.com/ugorji/go/codec`)
-- `github.com/ugorji/go/codec` (requires `github.com/ugorji/go`) [README](codec/README.md)
+- `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.
 
@@ -34,6 +34,6 @@ 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` is here for [historical compatibility reasons, as modules was initially introduced only at repo root](https://github.com/ugorji/go/issues/299)
 - `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)