https://github.com/josemsantos/jumia-travel-changelog-generator

Small but efficient tool to generate a CHANGELOG.md file for cross functional teams
https://github.com/josemsantos/jumia-travel-changelog-generator

automation changelog control deployment generate javascript nodejs quality release

Last synced: 8 days ago
JSON representation

Small but efficient tool to generate a CHANGELOG.md file for cross functional teams

• Host: GitHub
• URL: https://github.com/josemsantos/jumia-travel-changelog-generator
• Owner: josemsantos
• License: gpl-3.0
• Created: 2017-04-05T15:15:42.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-08-14T10:15:04.000Z (over 7 years ago)
• Last Synced: 2025-01-09T09:37:34.423Z (about 1 month ago)
• Topics: automation, changelog, control, deployment, generate, javascript, nodejs, quality, release
• Language: JavaScript
• Size: 43 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jumia-travel-changelog-generator

Small but efficient tool to generate a CHANGELOG.md file for cross functional teams

## The CHANGELOG.md generator

This tool is meant to generate automatically an extended and useful CHANGELOG.md report.

Each release is based on a milestone version and the due date.

## Jumia Travel Submission Guidelines

In order to generate a precise report, some guideline are requested to be followed:

- Each release should be based on a milestone

  - opened milestones are considered future releases

  - closed milestones are considered released and the close date is the release date

- A `TAG` should share the same name as the `milestone` e.g **V1.0.0** This will facilitate the creation of some links

- Pull request

  - Should be assigned to the milestone where they are meant to be released

  - comment should be meaningful, only the pull request comments are reported

  - Certain labels will group pull requests in `categories` make sure you assign meaningful labels to pull requests

    - **enhancement** group by **Improvements**

    - **bug** group by **Fixes**

    - any other or no labels will be assigned to **Others**

## Install and run this program

install this project:

make sure you have nodejs installed

~~~~

node --version

~~~~

You should see something like:

~~~~

v6.10.0

~~~~

If you don't have nodejs installed check [here](https://nodejs.org/en/download/)

~~~~

npm install jumia-travel-changelog --save

~~~~

## Options

Before running you should know about the available options:

    

        token

        Github API personal access token, you can generate one here

    

    

        repo

        the repo owner name and repo name e.g. josemsantos/jumia-travel-changelog-generator

    

    

        start

        The initial date to start the changelog, useful for projects that already has a CHANGELOG.md file. The format as to be YYYY-mm-dd e.g. 2015-03-21.

    

    

        baselog

        In case you already have a CHANGELOG.md file you can append it in your new one, just pass the path of your current file.

    

    

        classicoutput

        Prints the output using the shelljs library instead of using the terminal-kit library

    

You can execute the program as

~~~~

jumia-travel-changelog --token=ff2c276a78d7b795e65c2da99fc7d44e68fc6c2e --repo=josemsantos/jumia-travel-changelog-generator --baselog=/var/www/my-project/CHANGELOG-MANUAL.md

~~~~