CSharp SDK for CloudEvents

Go to file

Jon Skeet dd97fde565 Additional documentation for more CloudEventFormatter Signed-off-by: Jon Skeet <jonskeet@google.com>		2021-05-11 20:41:10 +01:00
.github/workflows	Actually push to NuGet when a release is triggered	2021-05-05 08:49:28 +01:00
.vscode	added support for version 0.3	2019-05-19 22:39:34 +02:00
docs	Additional documentation for more CloudEventFormatter	2021-05-11 20:41:10 +01:00
samples	First pass at new documentation for 2.0.0-beta.2 onwards	2021-05-05 08:27:25 +01:00
src	Implement JsonEventFormatter<T> for System.Text.Json	2021-05-11 20:41:10 +01:00
test	Additional documentation for more CloudEventFormatter	2021-05-11 20:41:10 +01:00
.gitignore	update version	2020-01-16 09:31:28 +01:00
CloudEvents.sln	Implement JsonEventFormatter for System.Text.Json	2021-03-24 07:22:41 +00:00
CloudEvents.sln.DotSettings	added support for version 0.3	2019-05-19 22:39:34 +02:00
CloudEvents.v3.ncrunchsolution	add support for parsing ASP.NET Core HTTP requests into CloudEvents	2019-10-31 15:24:54 +01:00
CloudEventsSdk.snk	Add strong naming for all projects	2020-07-14 19:05:46 +01:00
LICENSE	Initial commit	2018-09-20 15:57:22 -04:00
PROCESSES.md	First draft of a release process document	2020-11-11 07:38:08 +00:00
README.md	First pass at new documentation for 2.0.0-beta.2 onwards	2021-05-05 08:27:25 +01:00
appveyor.yml	Don't push to NuGet from AppVeyor	2021-01-15 17:34:06 +00:00

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 and does not have a default constructor to underline this. 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. We are hoping to provide a stable 2.0.0 release within the summer of 2021 (May/June/July).

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 Vasters on 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.