GitlabRepoStats/README.md

20 lines
851 B
Markdown
Raw Normal View History

2022-06-15 16:33:27 +02:00
# Gitlab Repo Stats
Tool for analysing gitlab repo statistics.
## Building
Prebuilt binaries available in [the releases tab](https://git.kallestruik.nl/kalle/GitlabRepoStats/releases) or you can build your own with:
```sh
git clone https://git.kallestruik.nl/kalle/GitlabRepoStats.git
cd GitlabRepoStats
./gradlew build
# Jar is now available at build/libs/GitlabRepoStats-1.0.jar
```
## Running
```sh
java -jar path/to/GitlabRepoStats.jar -u "https://url.of.gitlab.instance/" -t "PERSONAL_ACCESS_TOKEN" -p "project id" # options to enable statistics
```
### Available statistics
**--pipeline-stats**: Gather information about the pipelines that have been ran on this project.
**--issue-stats**: Gather information related to issues of this project. A CSV file for graphing time spent over time is output to `PWD/issue-stats_time-tracking.csv`.