https://github.com/pedrotroller/k-pi

https://github.com/pedrotroller/k-pi

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/pedrotroller/k-pi
• Owner: PedroTroller
• Created: 2024-02-29T12:58:11.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-06-17T05:16:01.000Z (6 months ago)
• Last Synced: 2024-10-28T13:37:21.214Z (about 2 months ago)
• Language: PHP
• Size: 227 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
The goal of this project is to make it easy to track metrics.

## Configuration

Just create a `.k-pi.dist.yaml` file following the following pattern:

```yaml

---

reports:

  :

    storage:

      : 

```

### Reference

#### `reports..extra`

If a report is compiled in one of the configured `storages`, then compiled

values can be added to it.

#### `reports..extra.total`

Add total metrics values to compiled report. Expected value is the label of the

metric.

```yaml

---

reports:

  :

    extras:

      total: The total

    # ...

```

#### `reports..colors`

Customize metrics colors on compiled reports. The expected value is a key-value

with the metric label as key, and a hex color code as value.

```yaml

---

reports:

  :

    colors:

      The total: "#CDCDCD"

      Metric 1: "#F2D6B1"

    # ...

```

#### `reports..precision`

Allows you to specify the precision to which metrics will be rounded. The

default setting is `2`.

#### `reports..storage`

Allows you to configure the way in which the metrics recorded in the report are

stored.

#### `reports..storage.github-discussion`

Integration with Github discussions.

#### `reports..storage.github-discussion.url`

Url of the target discussion (e.g.

https://github.com/KnpLabs/K-pi/discussions/1).

#### `reports..check-reporter`

Configure how metrics evolution is notified.

#### `reports..check-reporter.github-status`

Integration with Github status on pull-requests.

#### `reports..check-reporter.github-status.states`

#### `reports..check-reporter.github-status.states.on-lower`

#### `reports..check-reporter.github-status.states.on-higher`

#### `reports..check-reporter.github-status.unit`

#### `reports..check-reporter.github-status.unit.plural`

#### `reports..check-reporter.github-status.unit.singular`

## Integration with CI

### Github Actions

## Some examples

For all examples, please refer to the configuration file

[`.k-pi.dist.yaml`](./.k-pi.dist.yaml).

### Track test coverage

> See [`example-coverage.yaml`](./.github/workflows/example-coverage.yaml)

### Track Github dependabot security alerts

> See

> [`example-github-security.yaml`](./.github/workflows/example-github-security.yaml)

The goal of this metric is to count the number of alerts from dependabot's

Github API and project them onto a graph to track their evolution over time.

In the configuration file, you can see that the configured storage is

`github-discussion`. It means that data will be stored in the discussion but

also projected onto a graph.

### Track PhpMetrics data

> See [`example-phpmetrics.yaml`](./.github/workflows/example-phpmetrics.yaml)