Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Changelog

## [Unreleased]

### Changed

* [Allow use of asterisks for list items, and support nested lists](https://github.com/ionide/KeepAChangelog/pull/42)

## [0.3.2] - 2026.01.26

### Fixed
Expand Down
9 changes: 8 additions & 1 deletion src/Library.fs
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,14 @@ type ParseChangeLogs() =

member this.ParseChangelog(fileInfo: FileInfo) : Result<Changelog, unit> =
let changelogContent = File.ReadAllText(fileInfo.FullName)
let parserResult = ChangelogParser().Parse(changelogContent)

let changeLogParserSettings =
ChangelogParserSettings(
ChangelogListHandling = (ChangelogListHandling.AllowAsterisk ||| ChangelogListHandling.AllowNestedLists)
)

let parserResult =
ChangelogParser().Parse(changelogContent, changeLogParserSettings)

if parserResult.IsSuccess then
Ok parserResult.Value
Expand Down
28 changes: 28 additions & 0 deletions tests/UnitTests.fs
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,34 @@ type UnitTests() =
|> Seq.cast
|> _.Should().Contain("Date", "Should have date metadata"))

[<TestMethod>]
member this.``task correctly parses changelogs containing nested lists``() =
let myTask =
ParseChangeLogs(ChangelogFile = Workspace.changelogs.``CHANGELOG_lists.md``)

myTask.BuildEngine <- this.context.BuildEngine.Object

let success = myTask.Execute()
%success.Should().BeTrue "Should have successfully parsed the changelog data"
%myTask.AllReleasedChangelogs.Length.Should().Be(1, "Should have 1 version")

%myTask.CurrentReleaseChangelog.ItemSpec
.Should()
.Be("0.1.0", "Should have the most recent version")

%myTask.CurrentReleaseChangelog
.GetMetadata("Date")
.Should()
.Be("2026-01-26", "Should have the most recent version's date")

%(myTask.CurrentReleaseChangelog.MetadataNames
|> Seq.cast
|> _.Should().Contain("Changed", "Should have changed metadata"))

%(myTask.CurrentReleaseChangelog.MetadataNames
|> Seq.cast
|> _.Should().Contain("Added", "Should have added metadata"))

[<TestMethod>]
member this.``task produces expected markdown``() =
let myTask = ParseChangeLogs(ChangelogFile = Workspace.changelogs.``CHANGELOG.md``)
Expand Down
21 changes: 21 additions & 0 deletions tests/changelogs/CHANGELOG_lists.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Changelog

## [Unreleased]

### Removed

* A test removal line
* And another removal

## [0.1.0] - 2026-01-26

### Added

* Created the package

### Changed

* Changed something in the package
* Updated the target frameworks
* added .NET 10.0
* removed .NET 5.0
Loading