Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

ReleaseNotes

Contains helpers which allow to parse Release Notes text files. Either "simple" or "complex" format is accepted.

Formats

Simple format

1: 
2: 
* 1.1.10 - Support for heterogeneous XML attributes. Make CsvFile re-entrant.
* 1.1.9 - Infer booleans for ints that only manifest 0 and 1.

Complex format

 1: 
 2: 
 3: 
 4: 
 5: 
 6: 
 7: 
 8: 
 9: 
10: 
## New in 1.1.10 (Released 2013/09/12)
* Support for heterogeneous XML attributes.
* Make CsvFile re-entrant. 
* Support for compressed HTTP responses. 
* Fix JSON conversion of 0 and 1 to booleans.

## New in 1.1.9 (Released 2013/07/21)
* Infer booleans for ints that only manifest 0 and 1.    
* Support for partially overriding the Schema in CsvProvider.
* PreferOptionals and SafeMode parameters for CsvProvider.

Sample

 1: 
 2: 
 3: 
 4: 
 5: 
 6: 
 7: 
 8: 
 9: 
10: 
11: 
12: 
13: 
let release =
    ReadFile "RELEASE_NOTES.md"
    |> ReleaseNotesHelper.parseReleaseNotes


Target "AssemblyInfo" (fun _ ->
    CreateFSharpAssemblyInfo "src/Common/AssemblyInfo.fs"
      [ Attribute.Title project
        Attribute.Product project
        Attribute.Description summary
        Attribute.Version release.AssemblyVersion
        Attribute.FileVersion release.AssemblyVersion]
)

Nested types and modules

TypeDescription
ReleaseNotes

Contains the parsed information of the release notes text file.

Functions and values

Function or valueDescription
ReleaseNotes.load(fileName)
Signature: fileName:string -> ReleaseNotes

Parses a Release Notes text file and returns the lastest release notes.

Parameters

  • fileName - Release notes text file name
ReleaseNotes.parse(data)
Signature: data:seq<string> -> ReleaseNotes

Parses a Release Notes text and returns the lastest release notes.

Parameters

  • data - Release notes text
ReleaseNotes.parseAll(data)
Signature: data:seq<string> -> ReleaseNotes list

Parses a Release Notes text and returns all release notes.

Parameters

  • data - Release notes text
ReleaseNotes.parseAllComplex(text)
Signature: text:seq<string> -> ReleaseNotes list

Parse "complex" release notes text sequence

ReleaseNotes.parseDate
Signature: string -> DateTime option
ReleaseNotes.parseSimple(line)
Signature: line:string -> ReleaseNotes

Parse simple release notes sequence

ReleaseNotes.parseVersions
Signature: string -> Match * Match