Support and versioning on Dapr Docs

Versioning policy

Mon, 01 Jan 0001 00:00:00 +0000

Introduction

Dapr is designed for future changes in the runtime, APIs and components with versioning schemes. This topic describes the versioning schemes and strategies for APIs, manifests such as components and Github repositories.

Versioning

Versioning is the process of assigning either unique version names or unique version numbers to unique states of computer software.

Versioning provides compatibility, explicit change control and handling changes, in particular breaking changes.
Dapr strives to be backwards compatible. If a breaking change is needed it’ll be announced in advance.
Deprecated features are done over multiple releases with both new and deprecated features working side-by-side.

Versioning refers to the following Dapr repos: dapr, CLI, stable language SDKs, dashboard, components-contrib, quickstarts, helm-charts and documentation.

Supported runtime and SDK releases

Mon, 01 Jan 0001 00:00:00 +0000

Introduction

This topic details the supported versions of Dapr releases, the upgrade policies and how deprecations and breaking changes are communicated in all Dapr repositories (runtime, CLI, SDKs, etc) at versions 1.x and above.

Dapr releases use MAJOR.MINOR.PATCH versioning. For example, 1.0.0.

Versioning	Description
`MAJOR`	Updated when there’s a non-backward compatible change to the runtime, such as an API change. A `MAJOR` release can also occur then there is a considered a significant addition/change of functionality that needs to differentiate from the previous version.
`MINOR`	Updated as part of the regular release cadence, including new features, bug, and security fixes.
`PATCH`	Incremented for a critical issue (P0) and security hot fixes.

A supported release means:

Breaking changes and deprecations

Mon, 01 Jan 0001 00:00:00 +0000

Breaking changes

Breaking changes are defined as a change to any of the following that cause compilation errors or undesirable runtime behavior to an existing 3rd party consumer application or script after upgrading to the next stable minor version of a Dapr artifact (SDK, CLI, runtime, etc):

Code behavior
Schema
Default configuration value
Command line argument
Published metric
Kubernetes resource template
Publicly accessible API
Publicly visible SDK interface, method, class, or attribute

Breaking changes can be applied right away to the following cases:

Reporting security issues

Mon, 01 Jan 0001 00:00:00 +0000

The Dapr project and maintainers make security a central focus of how we operate and design our software. From the Dapr binaries to the GitHub release processes, we take numerous steps to ensure user applications and data is secure. For more information on Dapr security features, visit the security page.

Repositories and issues covered

When we say “a security vulnerability in Dapr”, this means a security issue in any repository under the dapr GitHub organization.

Preview features

Mon, 01 Jan 0001 00:00:00 +0000

Preview features in Dapr are considered experimental when they are first released.

Runtime preview features require explicit opt-in in order to be used. The runtime opt-in is specified in a preview setting feature in Dapr’s application configuration. See How-To: Enable preview features for more information.

For CLI there is no explicit opt-in, just the version that this was first made available.

Current preview features

Feature	Description	Setting	Documentation	Version introduced
Pluggable components	Allows creating self-hosted gRPC-based components written in any language that supports gRPC. The following component APIs are supported: State stores, Pub/sub, Bindings	N/A	Pluggable components concept	v1.9
Multi-App Run for Kubernetes	Configure multiple Dapr applications from a single configuration file and run from a single command on Kubernetes	`dapr run -k -f`	Multi-App Run	v1.12
Cryptography	Encrypt or decrypt data without having to manage secrets keys	N/A	Cryptography concept	v1.11
Actor State TTL	Allow actors to save records to state stores with Time To Live (TTL) set to automatically clean up old data. In its current implementation, actor state with TTL may not be reflected correctly by clients, read Actor State Transactions for more information.	`ActorStateTTL`	Actor State Transactions	v1.11
Component Hot Reloading	Allows for Dapr-loaded components to be “hot reloaded”. A component spec is reloaded when it is created/updated/deleted in Kubernetes or on file when running in self-hosted mode. Ignores changes to actor state stores and workflow backends.	`HotReload`	Hot Reloading	v1.13
Subscription Hot Reloading	Allows for declarative subscriptions to be “hot reloaded”. A subscription is reloaded either when it is created/updated/deleted in Kubernetes, or on file in self-hosted mode. In-flight messages are unaffected when reloading.	`HotReload`	Hot Reloading	v1.14
Workflows Clustered Deployment	Enable Workflows to function when workflow clients communicate to multiple daprds of the same appID who are behind a loadbalancer. Only relevant when using Dapr shared	`WorkflowsClusteredDeployment`	Dapr Shared	v1.16
Workflows Durable Activity Results	If set, ensures that activity results are durably sent to the owning workflow in multi-application scenarios, even when the owning workflow application is unavailable. Unless running multiple Dapr versions, this feature gate should be enabled. Disabled by default for backwards compatibility.	`WorkflowsRemoteActivityReminder`	Multi-application Workflows	v1.17

Alpha and Beta APIs

Mon, 01 Jan 0001 00:00:00 +0000

Alpha APIs

Building block/API	gRPC	HTTP	Description	Documentation	Version introduced
Query State	Query State proto	`v1.0-alpha1/state/statestore/query`	The state query API enables you to retrieve, filter, and sort the key/value data stored in state store components.	Query State API	v1.5
Distributed Lock	Lock proto	`/v1.0-alpha1/lock`	The distributed lock API enables you to take a lock on a resource.	Distributed Lock API	v1.8
Cryptography	Crypto proto	`v1.0-alpha1/crypto`	The cryptography API enables you to perform high level cryptography operations for encrypting and decrypting messages.	Cryptography API	v1.11
Jobs	Jobs proto	`v1.0-alpha1/jobs`	The jobs API enables you to schedule and orchestrate jobs.	Jobs API	v1.14
Streaming Subscription	Streaming Subscription proto	N/A	Subscription is defined in the application code. Streaming subscriptions are dynamic, meaning they allow for adding or removing subscriptions at runtime.	Streaming Subscription API	v1.14
Conversation	Conversation proto	`v1.0-alpha2/conversation`	Converse between different large language models using the conversation API.	Conversation API	v1.15

Beta APIs

No current beta APIs.