Write release notes
Generate the security section of your release notes from the resolutions in your Vulnlog file, instead of collecting the fixes by hand.
Before you start
-
A
resolutionon every entry that the release fixes. See Record a resolution. -
The release in
releases.
In this guide, Acme Shop releases 4.4.0, which fixes Spring4Shell.
Generate the release notes
-
Set
published_aton the release. See Add and publish releases. Without it, the notes show the release asunreleased. -
Generate the changelog for the release:
$ vulnlog report changelog acme-shop.vl.yaml --fixed-in 4.4.0 Acme Corp / Acme Shop 4.4.0 (2026-11-07) 1 fixed: 1 medium CVE-2022-22965 (medium) "Spring4Shell" Remote code execution through data binding in Spring Framework fix: Updated spring-beans from 5.3.15 to 5.3.18Each line shows the vulnerability ID, severity, name, and
description. For anot affectedentry, the line showsnot affectedin place of the severity. Thefixline is thenoteof the resolution. If the resolution has aref, the line below shows it. -
Copy the lines into your release notes.
If a line is missing words, add a description to the entry or a note to its resolution, then generate the changelog again.
Variants
If you keep a CHANGELOG.md file
Add --format markdown, and write the section to a file with -o:
$ vulnlog report changelog acme-shop.vl.yaml --fixed-in 4.4.0 --format markdown -o security-4.4.0.md
Wrote: security-4.4.0.md
Paste the section into CHANGELOG.md above the older releases.
Don’t append it with >>, which puts it at the end of the file, below the older releases.
Vulnlog writes one section per release, without the project heading:
## [4.4.0] - 2026-11-07
### Security
_1 fixed: 1 medium_
- **CVE-2022-22965** (medium): "Spring4Shell" Remote code execution through data binding in Spring Framework. Updated spring-beans from 5.3.15 to 5.3.18.
If your advisory only needs the IDs
Add --brief:
$ vulnlog report changelog acme-shop.vl.yaml --fixed-in 4.4.0 --brief
Acme Corp / Acme Shop
4.4.0 (2026-11-07)
1 fixed: 1 medium
CVE-2022-22965 (medium)
If you need every release
Leave out --fixed-in.
The changelog then lists each release that fixed something, newest first.
To stop at a release, use --as-of instead.
If you have several Vulnlog files
Pass all files, for example vulnlog report changelog acme-shop.vl.yaml acme-shop-3.vl.yaml.
They must have the same project values.
If you use the Gradle plugin
Run vulnlogChangelogReport.
It writes build/vulnlog/vulnlog-changelog.txt, or vulnlog-changelog.md when you set format to markdown:
vulnlog {
files.from("acme-shop.vl.yaml")
report {
changelog {
format = "markdown"
fixedIn = "4.4.0"
}
}
}
$ ./gradlew vulnlogChangelogReport
For all settings, see Gradle plugin.
Check the result
Compare the lines with the entries you expect.
An entry is missing when its resolution.in names another release, or when it has no resolution.
If no entry has a resolution in the release, the command prints info: no fixed vulnerabilities to report.
For all options, see vulnlog report changelog.