devbased/samples-dotnet

Samples for working with the Temporal .NET SDK

Temporal .NET SDK Samples

This is the set of .NET samples for the .NET SDK.

⚠️ UNDER ACTIVE DEVELOPMENT

The .NET SDK and is under active development and has not released a stable version yet. APIs may change in incompatible ways until the SDK is marked stable.

Usage

Prerequisites:

• .NET >= 6
• Local Temporal server running

Samples

• ActivityHeartbeatingCancellation - How to use heartbeating and cancellation handling in an activity.
• ActivitySimple - Simple workflow that runs simple activities.
• ActivityStickyQueues - Use a unique task queue per Worker to have certain Activities only run on that specific Worker.
• ActivityWorker - Use .NET activities from a workflow in another language.
• AspNet - Demonstration of a generic host worker and an ASP.NET workflow starter.
• ClientMtls - How to use client certificate authentication, e.g. for Temporal Cloud.
• DependencyInjection - How to inject dependencies in activities and use generic hosts for workers
• Encryption - End-to-end encryption with Temporal payload codecs.
• Polling - Recommended implementation of an activity that needs to periodically poll an external resource waiting its successful completion.
• Schedules - How to schedule workflows to be run at specific times in the future.
• WorkerVersioning - How to use the Worker Versioning feature to more easily deploy changes to Workflow & other code.

Development

Code formatting

This project uses StyleCop analyzers with some overrides in .editorconfig. To format, run:

dotnet format

Can also run with --verify-no-changes to ensure it is formatted.

VisualStudio Code

When developing in vscode, the following JSON settings will enable StyleCop analyzers:

    "omnisharp.enableEditorConfigSupport": true,
    "omnisharp.enableRoslynAnalyzers": true

Testing

Run:

dotnet test

Can add options like:

• --logger "console;verbosity=detailed" to show logs
• --filter "FullyQualifiedName=TemporalioSamples.Tests.ActivityWorker.ActivityWorkerTests.Main_RunActivity_Succeeds" to run a specific test