Commit 5dc7dbbc authored by Zied SELLAMI's avatar Zied SELLAMI
Browse files

Add README.MD

parent 0ea6a635
# Burndownchart installation and use
You can use the burndownchart project to build an html burndownchart of your gitlab project.
## Prerequisites
### Download Spark 2.2.0
```
wget http://www-eu.apache.org/dist/spark/spark-2.2.0/spark-2.2.0-bin-hadoop2.7.tgz
tar zxvf spark-2.2.0-bin-hadoop2.7.tgz
```
### Installing SBT
Ubuntu and other Debian-based distributions
```
echo "deb https://dl.bintray.com/sbt/debian /" | sudo tee -a /etc/apt/sources.list.d/sbt.list
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 2EE0EA64E40A89B84B2DF73499E82A75642AC823
sudo apt-get update
sudo apt-get install sbt
```
For other OS, please refer to http://www.scala-sbt.org/1.0/docs/Setup.html
### Create a private API Token on Gitlab
Visit [https://ci.linagora.com/profile/personal_access_tokens](https://ci.linagora.com/profile/personal_access_tokens) and create a private token for API access.
# Download and use of Burndownchart
```
git clone ssh://git@ci.linagora.com:7999/zsellami/burndownchart.git
cd burndownchart/
```
## Building a runnable jars
```
sbt compile
sbt package
```
## How to use
The program need 5 arguments:
*Project Name: name of a Gitlab project. Example: LINAGORA/LGS/OpenPaaS/james
*Milstone Name: name of a Milstone. Example: Sprint 30
*Private-token: your gitlab private token. Example: J-Wmzdnwf1SnxxmWbT35
*Temporary directory: a temporary folder. Example: /home/data/burndownchart/tmp
*Output file path: a html file path for the burndownchart result. Example: /home/data/burndown.html
The command to run the program is:
```
./spark-2.2.0-bin-hadoop2.7/bin/spark-submit ./burndownchart/target/scala-2.11/burndownchart_2.11-0.1-SNAPSHOT.jar "Project Name" "Milstone Name" "Private-token" "Temporary directory" "Output file path"
```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment