https://github.com/nicoespeon/pr-metrics
Get metrics from Pull-Requests
https://github.com/nicoespeon/pr-metrics
github metrics pull-requests
Last synced: about 1 month ago
JSON representation
Get metrics from Pull-Requests
- Host: GitHub
- URL: https://github.com/nicoespeon/pr-metrics
- Owner: nicoespeon
- Created: 2018-09-10T23:00:08.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-09-10T23:00:33.000Z (almost 8 years ago)
- Last Synced: 2025-07-17T08:22:56.432Z (12 months ago)
- Topics: github, metrics, pull-requests
- Language: Elixir
- Size: 105 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PR Metrics
This project aims to get metrics from Pull-Requests (e.g. evolution of PRs open-time).
## 👣 Get started
First, you need to install [Docker](https://docs.docker.com/install/) if you don't have it.
Then, [create a GitHub AccessToken](https://blog.github.com/2013-05-16-personal-api-tokens/) with the **repo** scope.
Once you've got your token, run `make bootstrap TOKEN=`.
> This builds the Docker image, installs deps and generates `config/config.secret.exs` with your token (it is not versioned 😉).
And, that's it 👐
## 🏃 Develop
If you want to run a custom command that is not in the following list, you can use `make run CMD=''`.
For instance: `make run CMD='elixir --version'` will run `elixir --version` in the Docker environment 🚢
### `make start` starts a server
Options:
* `PORT` to use a custom port (e.g. `make start PORT=4010`)
We use [remix](https://github.com/AgilionApps/remix) in dev to provide auto-reload functionality when you change the source code.
However, it's an old library that has not been updated for a long time. It may have some issues.
A known issue: when it recompiles, it won't tell you it's done. So you'll have something like:
```sh
iex(4)> warning: mtime (modified time) for "lib/pr_metrics.ex" was set to the future, resetting tonow
Compiling 1 file (.ex)
```
And you may wait for a success message. But it won't come.
Solution: actually, it has recompiled! Hit `Enter` (or any key) to see it:
```sh
iex(4)> warning: mtime (modified time) for "lib/pr_metrics.ex" was set to the future, resetting tonow
Compiling 1 file (.ex)
nil
iex(5)>
```
### `make test` runs tests
Options:
* `PORT` to use a custom port (e.g. `make test PORT=4011`)
### `make test_watch` runs tests in watch mode
Options:
* `PORT` to use a custom port (e.g. `make test_watch PORT=4011`)
### `make format` formats your code
💁 _At some point, this would be a pre-commit hook so you won't have to bother._
### `make docs` generates documentation of the application
### `make lint` lints your code
It may take some time the first time you run it because it generates the [Persistent Lookup Table (PLT)](https://hexdocs.pm/dialyxir/readme.html#with-explaining-stuff) to cache the output of the analysis.
## 💁 About
This project uses following technologies:
* [Docker](https://docs.docker.com/) to make development and deployment easy
* [Elixir](https://elixir-lang.org/) which is a dynamic, functional language designed for building scalable and maintainable applications.