Changelog (Fake)

Changelog.Changelog Type

Namespace: Fake.Core
Assembly: Fake.Core.ReleaseNotes.dll
Parent Module: Changelog
Base Type: obj
All Interfaces: IEquatable<Changelog> , IStructuralEquatable , IComparable<Changelog> , IComparable , IStructuralComparable

Holds data for a changelog file, which include changelog entries an other metadata

Record Field	Description
`Description` Full Usage: `Description` Field type: `string option`	The description Field type: `string option`
`Entries` Full Usage: `Entries` Field type: `ChangelogEntry list`	The change log entries Field type: `ChangelogEntry list`
`Header` Full Usage: `Header` Field type: `string`	the header line Field type: `string`
`Unreleased` Full Usage: `Unreleased` Field type: `Unreleased option`	The Unreleased section Field type: `Unreleased option`

Instance member	Description
`this.LatestEntry` Full Usage: `this.LatestEntry` Returns: `ChangelogEntry`	the latest change log entry Returns: `ChangelogEntry`
`this.PromoteUnreleased` Full Usage: `this.PromoteUnreleased` Parameters: version : `string` Returns: `Changelog`	Promote an unreleased changelog entry to a released one using version number version : `string` Returns: `Changelog`
`this.PromoteUnreleased` Full Usage: `this.PromoteUnreleased` Parameters: assemblyVersion : `string` nugetVersion : `string` Returns: `Changelog`	Promote an unreleased changelog entry to a released one assemblyVersion : `string` nugetVersion : `string` Returns: `Changelog`

Static member Description

Static member	Description
`Changelog.New(header, description, unreleased, entries)` Full Usage: `Changelog.New(header, description, unreleased, entries)` Parameters: header : `string` description : `string option` unreleased : `Unreleased option` entries : `ChangelogEntry list` Returns: `Changelog`	Create a new changelog record from given data header : `string` description : `string option` unreleased : `Unreleased option` entries : `ChangelogEntry list` Returns: `Changelog`


                
                  
                    
                      Changelog.New(header, description, unreleased, entries)

Full Usage: Changelog.New(header, description, unreleased, entries)

Parameters:

header : string

description : string option

unreleased : Unreleased option

entries : ChangelogEntry list

Returns: Changelog

Create a new changelog record from given data