---
# System prepended metadata

title: Introduce relevant security updates as part of the release notes

---

## Problem statement

Our existing process for release notes requires our team to update the documentation with all the details. Today, we do not have an automated process for extracting significant changes from our commits. Added to that, our patch releases are missing release notes (from what I noticed), an essential documentation for those seeking for CVE fixes. While it is possible to search for GitHub issues, it's not ideal.

## Requirements
- The process should not require manual updates into the documentation from our team.
- Sections must highlight the significant changes, outstanding enhancements, bug fixes and security updates based on the milestone.
- Developers should be able to use keywords to specify in which section their commit message must be included. For example: feature, fix, cve...
- Users should be able to see the content when a new release is published on GitHub using the release tab, or checking their GitHub notifications.

## Proposal

### Release notes

### Keycloak x.y.z

#### Highlights

(*Section with the most relevant changes, that our teams want to highlight to our community*)

#### Security updates

(*Security bug fixes & CVE fixes for third-party libraries*)
#### Breaking changes

(*Relevant breaking changes that will impact our community*)

#### Changelog

(*Generated changelog based on commit messages*)

## References

For more context about the importance of including CVE fixes in release notes, see the following resources:

- A detailed explanation of a recent vulnerability: [Vulnerability Spotlight: CVE-2023-0264](https://www.mogwailabs.de/en/blog/2023/04/vulnerability-spotlight-cve-2023-0264)
- An example of a well-structured release note: [Liquibase 4.16.0 Release](https://github.com/liquibase/liquibase/releases/tag/v4.16.0)
- Changelog for Quarkus releases - https://github.com/quarkusio/quarkus/releases
- JReleaser - https://jreleaser.org
- Changesets - https://github.com/changesets/changesets

