Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
c1982 committed Jan 16, 2022
1 parent ca019f4 commit 9518d20
Showing 1 changed file with 32 additions and 19 deletions.
51 changes: 32 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,33 +8,47 @@ Software Engineer Metrics
* victoriametrics-importurl
* check-interval

## Docker
## Runing

### Build
Download binary from releases

> docker build -t swed .
> ./swed --scm-gitlab-baseurl=https://your-domain-name/api/v4 --scm-gitlab-token=TOKEN --victoriametrics-importurl=http://localhost:8428/api/v1/import/prometheus --check-interval=1h
### Run
#### docker

> docker run --rm swed
```bash
docker run --rm --name=swed c1982/swed \
--scm-gitlab-baseurl=https://your-domain-name/api/v4 \
--scm-gitlab-token=TOKEN \
--victoriametrics-importurl=http://localhost:8428/api/v1/import/prometheus \
--check-interval=1h
```

#### docker-compose

```bash
git clone https://github.com/c1982/swe-dashboard.git
cd swe-dashboard/docker
docker-compose --env-file ./config.env up
```

## Metrics

* Cycletime
* TimeToOpen
* TimeToReview
* TimeToApprove
* TimeToMerge
* Friday MR/PR
* Long-Running MR/PR
* MR/PR Comments LeaderBoard
* MR/PR Participants LeaderBoard
* MR/PR Rates
* MR/PR Sizes
* MR/PR Throughput
* Self-Merging MR/PR
* Time to Open
* Time to Review
* Time to Approve
* Time to Merge
* Friday MRs/PRs
* Long-Running MRs/PRs
* MRs/PRs Comments LeaderBoard
* MRs/PRs Participants LeaderBoard
* MRs/PRs Rates
* MRs/PRs Sizes
* MRs/PRs Throughput
* Self-Merging MRs/PRs
* Developer Turnover Rate
* Unreviewed MR/PR
* Unreviewed MRs/PRs

## Supported SCM

Expand All @@ -46,4 +60,3 @@ Software Engineer Metrics

## Running

> swed --scm-gitlab-baseurl=https://your-domain-name/api/v4 --scm-gitlab-token=TOKEN --victoriametrics-importurl=http://localhost:8428/api/v1/import/prometheus --check-interval=1h

0 comments on commit 9518d20

Please sign in to comment.