Skip to content

Update README for v2.9.0 and add Red Hat as a user#684

Merged
fxamacker merged 1 commit intomasterfrom
fxamacker/update-readme-for-v2.9.0
Jul 14, 2025
Merged

Update README for v2.9.0 and add Red Hat as a user#684
fxamacker merged 1 commit intomasterfrom
fxamacker/update-readme-for-v2.9.0

Conversation

@fxamacker
Copy link
Copy Markdown
Owner

@fxamacker fxamacker commented Jul 14, 2025

Updates #683

Changes to the README related to v2.9:

v2.9.0 (Jul 13, 2025) improved interoperability/transcoding between CBOR & JSON, refactored tests, and improved docs.

  • Add opt-in support for encoding.TextMarshaler and encoding.TextUnmarshaler to encode and decode from CBOR text string.
  • Add opt-in support for json.Marshaler and json.Unmarshaler via user-provided transcoding function.
  • Update docs for TimeMode, Tag, RawTag, and add example for Embedded JSON Tag for CBOR.

Other changes to the README:

  • Add IBM and Red Hat to the top of README. Red Hat OpenShift uses fxamacker/cbor and two Red Hat employees contributed code to this project.

  • Remove some companies from top of README. E.g., the only Mozilla project that was using fxamacker/cbor was handed over to Veraison (a project of Confidential Computing Consortium).

  • Add an asterisk that links to files using fxamacker/cbor next to these to make it more convenient to see how the main branch of fxamacker/cbor is used:

    • Kubernetes*, Red Hat*, Tailscale*, Veraison*
  • Add a note about "toarray" struct tag option making the encoder ignore "omitempty" and "omitzero" to prevent the encoded array element positions from changing. This allows decoder to identify the Go struct field by array element position.

Added IBM and Red Hat to the top of README. Red Hat OpenShift uses fxamacker/cbor and two Red Hat employees contributed code to this project.

Removed some companies from top of README.  E.g., the only Mozilla project that was using fxamacker/cbor was handed over to Veraison (a project of Confidential Computing Consortium).

Added a note about "toarray" struct tag option making the encoder ignore "omitempty" and "omitzero" to prevent the encoded array element positions from changing.  This allows decoder to identify the Go struct field by array element position.
@fxamacker fxamacker added this to the v2.9.0 milestone Jul 14, 2025
@fxamacker fxamacker self-assigned this Jul 14, 2025
@fxamacker fxamacker added the docs label Jul 14, 2025
@fxamacker
Copy link
Copy Markdown
Owner Author

PTAL @x448

Copy link
Copy Markdown
Contributor

@x448 x448 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM except the comparison for decoding bad data is using old versions of the codecs.

@fxamacker
Copy link
Copy Markdown
Owner Author

LGTM except the comparison for decoding bad data is using old versions of the codecs.

I can update it next weekend.

@fxamacker fxamacker merged commit d29ad73 into master Jul 14, 2025
22 checks passed
@fxamacker fxamacker deleted the fxamacker/update-readme-for-v2.9.0 branch September 16, 2025 02:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants