/
action.yml
54 lines (44 loc) · 2.5 KB
/
action.yml
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
name: 'Add GitHub Sponsors to Readme'
description: 'This GitHub Action will automatically add your GitHub Sponsors to your README.'
author: 'James Ives <[email protected]>'
runs:
using: 'node20'
main: 'lib/main.js'
branding:
icon: 'heart'
color: 'red'
inputs:
token:
description: >
You must provide the action with a Personal Access Token (PAT) with either the user:read or org:read permission scope and store it in the secrets / with menu as a secret.
This should be generated from the account or organization that receives sponsorship.
[Learn more about creating and using encrypted secrets here.](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
required: true
file:
description: This should point to the file that you're generating, for example README.md or path/to/CREDITS.md
required: true
organization:
description: If you're displaying sponsorship information as an organization you should toggle this option to true. You also need to provide the action with an org:read scoped PAT.
required: false
minimum:
description: Using this input you can set the minimum sponsorship threshold. For example setting this to 500 will only display sponsors who give of $5 USD and more. By default the action will display all of your sponsors.
required: false
maximum:
description: For example setting this to 1000 will only display sponsors who give of $10 USD and less. By default the action will display all of your sponsors.
required: false
marker:
description: This allows you to modify the marker comment that is placed in your file. By default this is set to sponsors - <!-- sponsors --> <!-- sponsors -->, if you set this to gold for example you can place <!-- gold --> <!-- gold --> in your file.
required: false
template:
description: Allows you to modify the default template. Please refer to the `template` section of this README for more information.
required: false
fallback:
description: Allows you to specify a fallback if you have no sponsors. By default nothing is displayed.
required: false
active-only:
description: If set to false, inactive sponsors will be displayed. This can be useful if you want to display all sponsors, regardless of their status.
default: 'true'
required: false
outputs:
sponsorshipStatus:
description: 'The status of the action that indicates if the run failed or passed. Possible outputs include: success|failed'