parse_news

docblock
parse_news(path::String="NEWS.md") -> Vector{NewsVersion}

Parse NEWS.md into structured version entries.

Supports common formats:

  • # Package 1.0.0 (2024-01-15)
  • # v1.0.0
  • ## Version 1.0.0
  • # 1.0.0 - 2024-01-15 Categories are identified by level-2 headers (##).

Arguments

  • path::String: Path to the NEWS.md file

Returns

Vector of NewsVersion structs, most recent first.

Example

versions = parse_news("NEWS.md")
for v in versions
    println("Version $(v.version)")
    for (cat, items) in v.categories
        println("  $cat: $(length(items)) items")
    end
end