metrics/source/plugins/base/metadata.yml at master · TawfikYasser/metrics · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
name: "🗃️ Base content"
cost: 1 GraphQL request
categorie: core
supports:
  - user
  - organization
  - repository
inputs:

  # Base content
  base:
    description: Metrics base content
    type: array
    format: comma-separated
    default: header, activity, community, repositories, metadata
    values:
      - header       # name, commits calendar, ...
      - activity     # commits, issues/pull requests opened, ...
      - community    # following, stars, sponsors, ...
      - repositories # license, stars, forks, ...
      - metadata     # svg generation metadata

  # Number of repositories to use to computes metrics
  # Using more will result in more accurate metrics, but you may hit GitHub rate-limit more easily if you use a lot of plugins
  repositories:
    description: Number of repositories to use
    type: number
    default: 100
    min: 0

  # Include forked repositories into metrics
  repositories_forks:
    description: Include forks in metrics
    type: boolean
    default: no

  # Filter repositories by user affiliations
  # Note that it may affect some plugin outputs (broad affiliations will result in less representative metrics)
  repositories_affiliations:
    description: Repositories affiliations
    type: string
    default: owner
    values:
      - ""                  # Use all repositories related to you
      - owner               # Use repositories you own
      - collaborator        # Use repositories you have contributed too
      - organization_member # Use repositories where you're an organization member