overcast

Crates.ioovercast
lib.rsovercast
version0.1.3
sourcesrc
created_at2024-03-19 17:23:57.256731
updated_at2024-03-19 18:06:24.980286
descriptionStrongly typed changelogs for projects as changeable as the weather
homepagehttps://crates.io/crates/overcast
repositoryhttps://codeberg.org/timlyo/Overcast
max_upload_size
id1179502
size33,338
Tim (timlyo)

documentation

https://docs.rs/overcast

README

Overcast is a crate for defining strongly typed changelogs that change as often as the weather. It's designed to make it simple to Keep a Changelog.

Crates.io Version Crates.io License docs.rs

Example

A more complete example is available in get_overcast_changelog.rs, the structure used to render CHANGELOG.md.

let changelog = Changelog::new("My Changelog")
    .with_description("A changelog for amazing things")
    .add_release(Release::new(0, 1, 0)
        .with_date(1970, 1, 1)
        .added("New feature")
        .fixed("All the bugs")
    );

let markdown = render_markdown(&changelog).unwrap();

assert_eq!(
    markdown,
    "# My Changelog

A changelog for amazing things

### 0.1.0 - 1970-01-01

#### Added
- New feature


#### Fixed
- All the bugs

"
)
Commit count: 0

cargo fmt