metrics/source/plugins/sponsors/metadata.yml at master · brandondeval/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
name: "💕 GitHub Sponsors"
category: github
description: This plugin displays sponsors and introduction text from [GitHub sponsors](https://github.com/sponsors/).
examples:
  +GitHub sponsors card: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.sponsors.svg
  GitHub sponsors full introduction: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.sponsors.full.svg
index: 23
supports:
  - user
  - organization
  - repository
scopes:
  - read:user
  - read:org
inputs:

  plugin_sponsors:
    description: Enable sponsors plugin
    type: boolean
    default: no

  plugin_sponsors_sections:
    description: |
      Displayed sections
      - `goal`: display GitHub active goal
      - `about`: display GitHub sponsors introduction
      - `list`: display GitHub sponsors list
    type: array
    format: comma-separated
    default: goal, list, about
    example: goal, list, about
    values:
      - goal
      - about
      - list

  plugin_sponsors_past:
    description: |
      Display past sponsorships

      This feature requires a token from target account, as past sponsorships are gathered from sponsors activity and is private data.

      > ⚠️ Past sponsorships does not respect sponsors privacy because of current GitHub API limitations. This may be fixed in future releases.
    type: boolean
    default: no

  plugin_sponsors_size:
    description: Profile picture display size
    type: number
    default: 24
    min: 8
    max: 64