Giter Club home page Giter Club logo

changelog's Introduction

changelog

CircleCI Coverage Status Go Report Card

changelog is a command-line application to read and manipulate CHANGELOG.md files that follows the keepachangelog.com spec.

It can normalize the file (fmt), create a release (release) and show a specific version (show). See Usage for details.

Installation

Linux and macOS

The easiest way to install it is to download the latest version from GitHub releases.

There are precompiled binaries for macOS and Linux.

From source

Download and build the executable:

$ go get -u github.com/rcmachado/changelog
$ cd $GOPATH/github.com/rcmachado/changelog
$ make build

Usage

changelog manipulate and validate markdown changelog files following the keepachangelog.com specification.

Usage:
  changelog [command]

Available Commands:
  fmt         Reformat the change log file
  help        Help about any command
  release     Change Unreleased to [version]
  show        Show changelog for [version]

Flags:
  -f, --filename string   Changelog file or '-' for stdin (default "CHANGELOG.md")
  -h, --help              help for changelog
  -o, --output string     Output file or '-' for stdout (default "-")

Use "changelog [command] --help" for more information about a command.

fmt

Normalize file format (see Formatting for the specific transformation applied):

$ changelog fmt

show

Show what will be in the next release:

$ changelog show Unreleased

Show the change log for a specific version:

$ changelog show 1.2.3

release

Create a new release:

$ changelog release 1.2.4

Formatting

fmt command normalizes the changelog file. The idea is to always have the same output, no matter how messy the file is. Right now it doesn't do much, but the plan is to evolve it as a kind of go fmt for changelogs.

Currently, the following transformations are applied:

  • Sections are sorted (eg. Added, Changed, etc)
  • Version links are put at the bottom of the file
  • List bullet is always -

Contributing

To contribute, you can fork the repository and submit a Pull Request.

What needs to be done?

A lot of things! Take a look at the issues to find something.

I found a bug

Could you please fill an issue explaining what caused the issue and what did you expect to happen instead?

License

It's released under MIT license. See LICENSE file for details.

changelog's People

Contributors

rcmachado avatar

Watchers

Flavio Sales Truzzi avatar James Cloos avatar  avatar

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.