409982e9e9
Changes in this release: - Bug fix: the "source" attribute is now validated to be non-empty - Bug fix: the JSON event formatters comply with the clarified JSON event format spec - Dependency: Apache.Avro dependency updated to 1.11.0 - Feature: New package CloudNative.CloudEvents.Protobuf, released as 2.0.0-beta.1 Signed-off-by: Jon Skeet <jonskeet@google.com> |
||
|---|---|---|
| .github/workflows | ||
| .vscode | ||
| docs | ||
| samples | ||
| src | ||
| test | ||
| .gitignore | ||
| CloudEvents.sln | ||
| CloudEvents.sln.DotSettings | ||
| CloudEvents.v3.ncrunchsolution | ||
| CloudEventsSdk.snk | ||
| LICENSE | ||
| PROCESSES.md | ||
| README.md | ||
| generate_protos.sh | ||
| nuget-icon.png | ||
README.md
Status
This SDK current supports the following versions of CloudEvents:
- v1.0
sdk-csharp
.NET Standard 2.0 (C#) SDK for CloudEvents
The CloudNative.CloudEvents package provides support for creating, encoding,
decoding, sending, and receiving CNCF
CloudEvents. Most applications
will want to add dependencies on other CloudNative.CloudEvents.*
packages for specific event format and protocol binding support. See
the user guide for details of the packages available.
A few gotchas highlighted for the impatient who don't usually read docs
- The CloudEvent class is not meant to be used with object serializers like JSON.NET. If you need to serialize or deserialize a CloudEvent directly, always use a CloudEventFormatter such as JsonEventFormatter.
- Protocol binding integration is provided in the form of extensions and the objective of those extensions is to map the CloudEvent to and from the respective protocol message, such as an HTTP request or response. The application is otherwise fully in control of the client. Therefore, the extensions do not add security headers or credentials or any other headers or properties that may be required to interact with a particular product or service. Adding this information is up to the application.
User guide and other documentation
The docs/ directory contains more documentation, including the user guide. Feedback on what else to include in the documentation is particularly welcome.
Changes since 1.x
From version 2.0.0-beta.2, there are a number of breaking changes compared with the 1.x series of releases. New code is strongly encouraged to adopt the latest version rather than relying on the 1.3.80 stable release.
The stable 2.0.0 version was released on June 15th 2021, and all users are encouraged to use this (or later) versions.
A more details list of changes is provided within the documentation.
Community
- There are bi-weekly calls immediately following the Serverless/CloudEvents call at 9am PT (US Pacific). Which means they will typically start at 10am PT, but if the other call ends early then the SDK call will start early as well. See the CloudEvents meeting minutes to determine which week will have the call.
- Slack: #cloudeventssdk channel under CNCF's Slack workspace.
- Email: https://lists.cncf.io/g/cncf-cloudevents-sdk
- Contact for additional information: Clemens Vasters (
@Clemens Vasterson slack).
Each SDK may have its own unique processes, tooling and guidelines, common
governance related material can be found in the
CloudEvents community
directory. In particular, in there you will find information concerning
how SDK projects are
managed,
guidelines
for how PR reviews and approval, and our
Code of Conduct
information.