Skip to content

ChangelogDocument

type ChangelogDocument =
    {
        Name: string option
        Preamble: string
        Versions: ChangelogVersion list
    }
AssemblyNacara.Plugin.Changelog

A parsed changelog.

Fields

Name: string option

What the file calls itself, from name: in its front matter.

EasyBuild.ShipIt writes and reads it the same way, so a changelog that already names itself for release notes names its page too.

Preamble: string

Everything before the first version, usually a title and a preamble.

Versions: ChangelogVersion list