changelog/README.md: specify current security fix section format

The entries added in changelog/security/ do not follow our existing
security section in the release notes:
  https://www.flatcar.org/releases/#release-3033.2.0

Document the structure and an example to use the right format that we
need for release note generation.
This commit is contained in:
Kai Lueke 2022-01-12 16:53:59 +01:00
parent d133e03f4a
commit 27541f3a92

View File

@ -29,3 +29,11 @@ As `Updates` refer to the package updates, contents of the file should be of
the following format: `- Package Name ([Version](link to changelog))`. Example:
`- Linux ([5.10.77](https://lwn.net/Articles/874852/))`. Note the leading dash
that will create a bullet list in the rendered markdown.
The security section follows this format:
```
- Package Name ([CVE-NUMBER](NIST-LINK), [CVE-NUMBER](NIST-LINK), ...)
```
E.g., `Linux ([CVE-2021-4002](https://nvd.nist.gov/vuln/detail/CVE-2021-4002), [CVE-2020-27820](https://nvd.nist.gov/vuln/detail/CVE-2020-27820))`.