...
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
...
Category | Valid alternate | Focus |
|---|---|---|
|
| Changes to CockroachDB features requiring an enterprise license, e.g., |
|
| Changes to This includes changes to logging configurations and behavior, environment variables, integrations with service managers, CLI flags for server commands, exit codes, etc. |
|
| Changes to This includes changes to the SQL shells, |
|
| Changes to SQL statements, functions/operators, or execution. |
|
| Changes to APIs /wiki/spaces/OI/pages/856851129, including classification and versioning. |
|
| Changes to the DB Console or any associated endpoints. |
|
| Changes that impacts the use of security features (IAM, TLS, etc.) or the security profile of the product. |
|
| Changes that improve performance, often at kv, storage, and SQL engine levels. |
|
| Changes that fix known problems as opposed to add or improve functionality. |
|
| 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. |
| Changes to requirements for building CockroachDB from source. | |
|
| 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. |
...