ReleaseNotes Module
Contains helpers which allow to parse Release Notes text files. Either "simple" or "complex" format is accepted.
Formats:
- Simple format
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
### 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.
Example
#r "paket:
nuget Fake.Core.ReleaseNotes //"
let release = ReleaseNotes.load "RELEASE_NOTES.md"
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]
)Types
| Type | Description |
Contains the parsed information of the release notes text file. |
Functions and values
| Function or value | Description |
Full Usage:
ReleaseNotes.load fileName
Parameters:
string
-
Release notes text file name
Returns: ReleaseNotes
|
Parses a Release Notes text file and returns the latest release notes.
|
Full Usage:
ReleaseNotes.parse data
Parameters:
seq<string>
-
Release notes text
Returns: ReleaseNotes
|
Parses a Release Notes text and returns the latest release notes.
|
Full Usage:
ReleaseNotes.parseAll data
Parameters:
seq<string>
-
Release notes text
Returns: ReleaseNotes list
|
Parses a Release Notes text and returns all release notes.
|