https://github.com/fthevenet/changelog-maker

A command line tool that creates a changelog from a Github project's release history.
https://github.com/fthevenet/changelog-maker

changelog changelog-generator github-releases java markdown

Last synced: 3 months ago
JSON representation

A command line tool that creates a changelog from a Github project's release history.

• Host: GitHub
• URL: https://github.com/fthevenet/changelog-maker
• Owner: fthevenet
• License: apache-2.0
• Created: 2019-01-12T11:06:31.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-01-13T09:34:45.000Z (over 6 years ago)
• Last Synced: 2025-02-09T15:13:48.583Z (5 months ago)
• Topics: changelog, changelog-generator, github-releases, java, markdown
• Language: Java
• Homepage:
• Size: 92.8 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# changelog-maker

[![Build Status](https://img.shields.io/travis/fthevenet/changelog-maker.svg?logo=travis&logoColor=white&style=flat-square)](https://travis-ci.org/fthevenet/changelog-maker)

[![Maven Central](https://img.shields.io/maven-central/v/eu.fthevenet/changelog-maker.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22eu.fthevenet%22%20AND%20a:%22changelog-maker%22)

A command line tool that creates a changelog from a Github project's release history.

It works by pulling all the releases for a specified repository and write a new file with the name, version, date and description of each releases, in a choice of formats (Plain text, Markdown, HTML or PDF).

    Usage: changelog [-hV] [-d=] [-f=] [-o=]

                     [-t=]  

    Create a changelog from a Github project's release history

                       The repository's owner name

                        The repository's name

      -d, --dateformat=

                              The date format to use (see https://docs.oracle.

                                com/javase/8/docs/api/java/text/SimpleDateFormat.html)

      -f, --format=   The format for the changelog: Plain text (TXT), Markdown

                                (MD), Html (HTML) or Pdf (PDF)

      -h, --help              Show this help message and exit.

      -o, --output=   The path to a file into which the changelog should be

                                written

      -t, --oauthtoken=

                              An OAuth2 token to use to access Github API

      -V, --version           Print version information and exit.