metrics/source/plugins/contributors/metadata.yml at master · yonseimath/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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
name: "🏅 Repository contributors"
category: github
description: This plugin display repositories contributors from a commit range along with additional stats.
examples:
  +by contribution types: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.contributors.categories.svg
  by number of contributions: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.contributors.contributions.svg
index: 6
supports:
  - repository
scopes:
  - public_access
inputs:

  plugin_contributors:
    description: Enable contributors plugin
    type: boolean
    default: no

  plugin_contributors_base:
    description: Base reference (commit, tag, branch, etc.)
    type: string
    default: ""
    example: commit, tag or branch

  plugin_contributors_head:
    description: Head reference (commit, tag, branch, etc.)
    type: string
    default: master

  plugin_contributors_ignored:
    description: |
      Ignored users

      Useful to ignore bots activity
    type: array
    format: comma-separated
    default: ""
    inherits: users_ignored

  plugin_contributors_contributions:
    description: Toggle number of contributions display
    type: boolean
    default: no

  plugin_contributors_sections:
    description: |
      Displayed sections
      - `contributors`: all contributors
      - `categories`: contributors sorted by contributions categories
    type: array
    format: comma-separated
    default: contributors
    example: contributors
    values:
      - contributors
      - categories

  plugin_contributors_categories:
    description: |
      Configure contribution categories

      This option required `plugin_contributors_sections` to have `categories` in it to be effective
      Pass a JSON object mapping category with fileglobs
    type: json
    default: |
      {
        "📚 Documentation": ["README.md", "docs/**"],
        "💻 Code": ["source/**", "src/**"],
        "#️⃣ Others": ["*"]
      }
    extras: yes