Git Product home page Git Product logo

keep_a_changelog's Introduction

Keep a Changelog Serializer/Deserializer

Build Status Docs Latest Version MSRV

A serializer and deserializer for changelogs written in Keep a Changelog format.

Install

cargo add keep_a_changelog

Usage

use keep_a_changelog::{Changelog, ChangeGroup, PromoteOptions};

fn main() {
    // parse a changelog
    let mut changelog: Changelog = "\
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]"
        .parse()
        .unwrap();
    
    // modify the unreleased section
    changelog.unreleased.add(
        ChangeGroup::Fixed, 
        "Fixed bug in feature X"
    );
    changelog.unreleased.add(
        ChangeGroup::Deprecated, 
        "Feature Y will be removed from the next major release"
    );
    
    // promote the unreleased changes to a new release
    let promote_options = PromoteOptions::new("0.0.1".parse().unwrap())
        .with_link("https://github.com/my-org/my-project/releases/v0.0.1".parse().unwrap());
    changelog.promote_unreleased(&promote_options).unwrap();

    // output the changelog
    println!("{}", changelog);
}

keep_a_changelog's People

Contributors

colincasey avatar runesoerensen avatar dependabot[bot] avatar

Stargazers

Josh W Lewis avatar Jonathan McAllister avatar  avatar

Watchers

 avatar  avatar Josh W Lewis avatar

Forkers

runesoerensen

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.