domains / cloud-infra / Kong/kong
Release note formatting
When updating documentation that is consumed by automated release tooling (such as changelog YAML), verify both the semantic classification and the generated markdown rendering.
When updating documentation that is consumed by automated release tooling (such as changelog YAML), verify both the semantic classification and the generated markdown rendering.
Apply a checklist before merge:
- Set the correct change
typefor the user impact (e.g., if behavior changes and can break workflows, preferbreaking_changeoverbugfix). - Write
messagein a release-friendly structure. If the release generator turnsmessageinto markdown list items, keep the first line as a short sentence and add clear sub-bullets rather than long, unstructured paragraphs.
Example:
type: breaking_change
message: |
Changed the default value of `nginx_http_client_max_body_size` from `0` (unbounded) to `10m`.
- Requests larger than the new limit may be rejected.
- Update Kong/Nginx settings if you rely on larger request bodies.