An open API service indexing awesome lists of open source software.

https://github.com/xmidt-org/gokeepachangelog

A simple golang library for working with changelogs that conform to https://keepachangelog.com.
https://github.com/xmidt-org/gokeepachangelog

Last synced: about 2 months ago
JSON representation

A simple golang library for working with changelogs that conform to https://keepachangelog.com.

Awesome Lists containing this project

README

        

# gokeepachangelog

Enabling you to do fun things with a changelog.

[![Build Status](https://github.com/xmidt-org/gokeepachangelog/actions/workflows/ci.yml/badge.svg)](https://github.com/xmidt-org/gokeepachangelog/actions/workflows/ci.yml)
[![codecov.io](http://codecov.io/github/xmidt-org/gokeepachangelog/coverage.svg?branch=main)](http://codecov.io/github/xmidt-org/gokeepachangelog?branch=main)
[![Go Report Card](https://goreportcard.com/badge/github.com/xmidt-org/gokeepachangelog)](https://goreportcard.com/report/github.com/xmidt-org/gokeepachangelog)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xmidt-org_gokeepachangelog&metric=alert_status)](https://sonarcloud.io/dashboard?id=xmidt-org_gokeepachangelog)
[![Apache V2 License](http://img.shields.io/badge/license-Apache%20V2-blue.svg)](https://github.com/xmidt-org/gokeepachangelog/blob/main/LICENSE)
[![GitHub Release](https://img.shields.io/github/release/xmidt-org/gokeepachangelog.svg)](CHANGELOG.md)
[![GoDoc](https://pkg.go.dev/badge/github.com/xmidt-org/gokeepachangelog)](https://pkg.go.dev/github.com/xmidt-org/gokeepachangelog)

## Summary

Keeping a changelog as https://keepachangelog.com suggests is a great way to
help communicate releases of software. This library processes that file into
a useful go structure that can be examined, updated and output.

## Table of Contents

- [Code of Conduct](#code-of-conduct)
- [Details](#details)
- [Install](#install)
- [Contributing](#contributing)

## Code of Conduct

This project and everyone participating in it are governed by the [XMiDT Code Of Conduct](https://xmidt.io/docs/community/code_of_conduct/).
By participating, you agree to this Code.

## Details

Add details here.

## Install

Add details here.

## Contributing

Refer to [CONTRIBUTING.md](CONTRIBUTING.md).