https://github.com/3zcurdia/reportcopter

Generate changelog reports based on git log and release tags
https://github.com/3zcurdia/reportcopter

changelog git golang logging reporting tool

Last synced: 3 months ago
JSON representation

Generate changelog reports based on git log and release tags

• Host: GitHub
• URL: https://github.com/3zcurdia/reportcopter
• Owner: 3zcurdia
• License: mit
• Created: 2015-08-15T06:14:39.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-01-16T06:02:34.000Z (about 7 years ago)
• Last Synced: 2024-06-19T04:11:10.369Z (8 months ago)
• Topics: changelog, git, golang, logging, reporting, tool
• Language: Go
• Size: 10.7 KB
• Stars: 15
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# reportcopter 

[![wercker status](https://app.wercker.com/status/535b33345ba6504c8ae4701aa354db9d/s "wercker status")](https://app.wercker.com/project/bykey/535b33345ba6504c8ae4701aa354db9d)

Why create release changes manualy when you have a well documented control version?

This tool generate changelog reports based on ```git-log``` and the difference between release tags.

If you want to see how the output looks, check the changelog from this project [here](./changelog.md)

## Features

* Regular expresion input for release tags

* Multiple output format

  * JSON

  * Markdown

  * Html

## Install

Download the binaries or install via go

    go get github.com/3zcurdia/reporcopter

## Usage

    $ reporcopter >> changelog.md

### Options

    reporcopter [global options] command [command options] [arguments...]

    COMMANDS:

       help, h  Shows a list of commands or help for one command

    GLOBAL OPTIONS:

        --pattern, -p "v[\d{1,4}\.]{1,}"	Regular expresion for release tags

        --format,  -f "markdown"	      	Output format for report

## Contribue to the project

To contribuer Just follow the next stepts:

* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it

* Fork the project

* Start a feature/bugfix branch

* Commit and push until you are happy with your contribution

* It is desired to add some tests for it.

## License

The MIT License (MIT)