v2.6.0

[fxamacker]

This release adds important new features, optimizations, bug fixes, and 3 new contributors. Fuzz tests passed 5+ billion execs for CBOR encoding and decoding functions. Minimum officially supported Go is bumped to Go 1.17.

⭐ Features and Optimizations

• Add FieldNameMatching decode option. by @benluddy in Add FieldNameMatching decode option. #433
• Add option to decode CBOR bignum to interface{} as *big.Int by @fxamacker in Add option to decode CBOR bignum to interface{} as *big.Int #456
• Add 2 more options for decoding CBOR integers to interface{} by @fxamacker in Add 2 more options for decoding CBOR integers to interface{} #457
• Add encoding option to specify how omitempty fields are encoded by @dinhxuanvu in Add encoding option to specify how omitempty fields are encoded #453
• New options for encoding Go strings to and from CBOR byte strings by @benluddy in New options for encoding Go strings to and from CBOR byte strings #465
• Add options to support byte string map keys as struct field names by @benluddy in Add options to support byte string map keys as struct field names #472
• Add option to specify how to decode unrecognized CBOR tag to any by @ssuriyan7 in Add option to specify how to decode unrecognized CBOR tag to any #475

🚀 Notable Optimizations

• Improve memory allocs 🗜️ and speed 🚀 of encoding maps by using Go 1.18-1.20 features by @dinhxuanvu in Improve memory allocs and speed of encoding maps by using Go 1.18+ features  #468

  📊 Benchmarks

  benchstat results provided by @dinhxuanvu

  

  NOTE: Go 1.17 is the minimum version supported by v2.6.0. Go 1.20+ will use optimizations introduced by PR 468.

🛠 Improvements

• Refactor valid() to reject negative values for integer modes by @fxamacker in Refactor valid() to reject negative values for integer modes #434
• Refactor tests to improve consistency and readability by @fxamacker in Refactor tests to improve consistency and readability #458
• Add another test and fix lint errors by @fxamacker in Add another test and fix lint errors #466
• Refactor map encoding to prep for Go version bump by @fxamacker in Refactor map encoding to prep for Go version bump #473
• Add UnrecognizedTagToAny option to TestDecOptions by @fxamacker in Add UnrecognizedTagToAny option to TestDecOptions #484
• Update go.mod to require go 1.17 by @fxamacker in Update go.mod to require go 1.17 #489

🐞 Bug Fixes

• Fix panic when decoding CBOR nil to *cbor.SimpleValue by @fxamacker in Fix panic when decoding CBOR nil to *cbor.SimpleValue #461
• Fix cbor.SimpleValue encoding and decoding by @fxamacker in Fix cbor.SimpleValue encoding and decoding #464
• Fix EncOption/DecOption unset fields on mode regurgitation. by @benluddy in Fix EncOption/DecOption unset fields on mode regurgitation. #480

📖 Docs and CI

• Update README for error handling of CBOR extraneous data by @fxamacker in Update README for error handling of CBOR extraneous data #426
• Update README for changes in cbor v2.5.0 by @fxamacker in Update README for changes in cbor v2.5.0 #427
• Update CI and README by @fxamacker in Update CI and README #430
• Update README to add FIDO Alliance, Let's Encrypt, Matrix.org by @fxamacker in Update README to add FIDO Alliance, Let's Encrypt, Matrix.org #431
• Pin actions/checkout and actions/setup-go by @x448 in Pin actions/checkout and actions/setup-go #436
• Enable more linters by @fxamacker in Enable more linters #437
• Bump github/codeql-action from 2.22.5 to 2.22.8 by @dependabot in Bump github/codeql-action from 2.22.5 to 2.22.8 #443
• Document behavior of Unmarshal of unrecognized tags into interface{} by @benluddy in Document behavior of Unmarshal of unrecognized tags into interface{} #448
• Bump github/codeql-action from 2.22.8 to 3.22.12 by @dependabot in Bump github/codeql-action from 2.22.8 to 3.22.12 #455
• Bump github/codeql-action from 3.22.12 to 3.23.0 by @dependabot in Bump github/codeql-action from 3.22.12 to 3.23.0 #469

New Contributors

• @benluddy made their first contribution in Add FieldNameMatching decode option. #433
• @dinhxuanvu made their first contribution in Add encoding option to specify how omitempty fields are encoded #453
• @ssuriyan7 made their first contribution in Add option to specify how to decode unrecognized CBOR tag to any #475

Full Changelog: v2.5.0...v2.6.0

---

This discussion was created from the release v2.6.0.