github-star-tracker/action.yml at main · fbuireu/github-star-tracker · 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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
name: 'GitHub Star Tracker'
description: 'Track star count changes across your repositories with historical reports and badges'
author: 'Ferran Buireu'

branding:
  icon: 'star'
  color: 'yellow'

inputs:
  github-token:
    description: 'Personal Access Token (PAT) with repo or public_repo scope - GITHUB_TOKEN does not work'
    required: true

  github-api-url:
    description: 'GitHub API base URL for GitHub Enterprise Server (e.g. https://github.example.com/api/v3). Auto-detected on GHES runners.'
    required: false
    default: ''

  config-path:
    description: 'Path to the configuration file (relative to repo root)'
    required: false
    default: 'star-tracker.yml'

  visibility:
    description: 'Repository visibility filter: public, private, all, or owned (only repos you own) (overrides config file)'
    required: false
    default: ''

  include-archived:
    description: 'Include archived repositories (overrides config file)'
    required: false
    default: ''

  include-forks:
    description: 'Include forked repositories (overrides config file)'
    required: false
    default: ''

  exclude-repos:
    description: 'Comma-separated list of repository names or regex patterns (e.g. /^test-.*/) to exclude (overrides config file)'
    required: false
    default: ''

  only-repos:
    description: 'Comma-separated list of repository names to exclusively track (overrides config file)'
    required: false
    default: ''

  min-stars:
    description: 'Only track repos with at least this many stars (overrides config file)'
    required: false
    default: ''

  data-branch:
    description: 'Branch name for storing tracking data'
    required: false
    default: 'star-tracker-data'

  max-history:
    description: 'Maximum number of snapshots to keep in history'
    required: false
    default: '52'

  smtp-host:
    description: 'SMTP server host. Providing this enables built-in email notifications'
    required: false
    default: ''

  smtp-port:
    description: 'SMTP server port'
    required: false
    default: '587'

  smtp-username:
    description: 'SMTP authentication username'
    required: false
    default: ''

  smtp-password:
    description: 'SMTP authentication password'
    required: false
    default: ''

  email-to:
    description: 'Email recipient address'
    required: false
    default: ''

  email-from:
    description: 'Email sender name or address'
    required: false
    default: 'GitHub Star Tracker'

  send-on-no-changes:
    description: 'Send email even when no star changes are detected'
    required: false
    default: 'false'

  include-charts:
    description: 'Include star trend charts in reports (true/false)'
    required: false
    default: 'true'

  notification-threshold:
    description: 'Star change threshold before sending notification: 0 (every run), a number (e.g. 5), or "auto" (adaptive)'
    required: false
    default: '0'

  locale:
    description: 'Language for reports and emails: en, es, ca, it'
    required: false
    default: 'en'

  top-repos:
    description: 'Number of top repositories to feature in charts and forecasts (by star count)'
    required: false
    default: '10'

  track-stargazers:
    description: 'Track individual stargazers and show new ones in reports (true/false)'
    required: false
    default: 'false'

outputs:
  report:
    description: 'Markdown report of star changes'

  report-html:
    description: 'HTML report of star changes (for email)'

  total-stars:
    description: 'Total star count across all tracked repositories'

  stars-changed:
    description: 'Whether any star counts changed since last run (true/false)'

  new-stars:
    description: 'Number of new stars gained since last run'

  lost-stars:
    description: 'Number of stars lost since last run'

  should-notify:
    description: 'Whether the notification threshold was reached (true/false)'

  report-csv:
    description: 'CSV report of star changes'

  new-stargazers:
    description: 'Number of new stargazers detected since last run (0 if tracking disabled)'

runs:
  using: 'node24'
  main: 'dist/index.js'