jumia-travel-changelog
v0.9.2
Published
This tool is meant to automatize the process of creating and maintening a CHANGELOG.md file. Based on github pull requests and milestones it will report a complete list of releases with all events. All future milestones are considered future releases.
Downloads
67
Maintainers
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 themilestone
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
npm install jumia-travel-changelog --save
Options
Before running you should know about the available options:
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