Note: This API documentation is for FAKE version 4. The migration API documentation can be found here. The API documentation for the new fake 5 modules can be found here

ReleaseNotesHelper

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
LoadReleaseNotes(fileName)
Signature: fileName:string -> ReleaseNotes

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

Parameters

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

Parses a Release Notes text and returns all release notes.

Parameters

  • data - Release notes text
parseDate
Signature: string -> DateTime option
parseReleaseNotes(data)
Signature: data:seq<string> -> ReleaseNotes

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

Parameters

  • data - Release notes text
parseVersions
Signature: string -> Match * Match