Dafda

TL;DR: Dafda is a small Kafka client library for .NET.

Documentation and Examples

See dfds.github.io/dafda for more the documentation, or check the Examples folder in the repository.

Building and Releasing

Dafda is build and released using a combination of make and GitHub Actions

You will need the dotnet sdk. Refer to the Microsoft Documentation on how to install

Dafda is available on NuGet.

Versioning

Run:

make version

And input the new version of Dafda. This will update the Dafda.csproj with the new version.

NuGet Packages

Run:

make release
git push --follow-tags

Will git tag with the current version (see Versioning, and GitHub Actions will take care of building, and pushing to NuGet.

Documentation

Documentation is written in markdown, and compiled to a static site using MkDocs and Material for MkDocs, and hosted on GitHub.

Development

make docs-dev

Uses docker-compose to run MkDocs development server, which watches changes to /docs folder. The website is available on http://localhost:8000.

Release

make docs-deploy

Will build and deploy the static site to GitHub Pages.