Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


Do NOT write release note texts for purely internal changes, such as:

  • Functionality that is not accessible to or intended for external users do not have access to (e.g., multi-tenant capabilities)

  • Code refactors

  • Testing/infrastructure work



Valid alternate


enterprise change


Changes to CockroachDB features requiring an enterprise license, e.g., BACKUP/RESTORE.

ops change

operational change

Changes to cockroach commands that affect primarily operators tasked with setting up and maintaining production clusters.

This includes changes to logging configurations and behavior, environment variables, integrations with service managers, CLI flags for server commands, exit codes, etc.

cli change


Changes to cockroach commands that affect primarily application developers, CockroachDB developers and contributors, and operators running experiments or small-scale testing/staging clusters.

This includes changes to the SQL shells, userfileworkloaddebug commands that operate on non-running servers, etc.

sql change


Changes to SQL statements, functions/operators, or execution.

api change


Changes to APIs /wiki/spaces/OI/pages/856851129, including classification and versioning.

ui change


Changes to the DB Console or any associated endpoints.

security update


security change

Changes that impacts the use of security features (IAM, TLS, etc.) or the security profile of the product. 

performance improvement


performance change

Changes that improve performance, often at kv, storage, and SQL engine levels.

bug fix


Changes that fix known problems as opposed to add or improve functionality.

general change


core change

Changes that don't fit anywhere else. Only use this if you have no other good option. This might include changes to logs and user-facing configs for Kubernetes, Prometheus, Alertmanager, etc. We probably need new, meaningful categories. 

build change

Changes to requirements for building CockroachDB from source.

backward-incompatible change

backwards-incompatible change

Changes that can break programmatic usage of an interface. This will be defined more clearly soon because not all interfaces are programmable, but examples are when an interface is remove, stops accepting a certain syntax or values, or has a new default value. See past examples.