Skip to main content

​
Required Inputs

​
github-token
string
required
Personal Access Token (PAT) with repo or public_repo scope.Important: GITHUB_TOKEN does not work. You must use a Personal Access Token.
- uses: fbuireu/github-star-tracker@v1
  with:
    github-token: ${{ secrets.PAT_TOKEN }}

​
Optional Inputs

​
API Configuration

​
github-api-url
string
default:""
GitHub API base URL for GitHub Enterprise Server (e.g., https://github.example.com/api/v3).Auto-detected on GHES runners. Leave empty for github.com.
​
config-path
string
default:"star-tracker.yml"
Path to the configuration file relative to repository root.
- uses: fbuireu/github-star-tracker@v1
  with:
    config-path: .github/star-tracker.yml

​
Repository Filtering

​
visibility
string
default:""
Repository visibility filter. Overrides config file.Options:
  • public - Only public repositories
  • private - Only private repositories
  • all - All repositories
  • owned - Only repositories you own
​
include-archived
boolean
default:""
Include archived repositories. Overrides config file.Set to true or false. Empty string uses config file value.
​
include-forks
boolean
default:""
Include forked repositories. Overrides config file.Set to true or false. Empty string uses config file value.
​
exclude-repos
string
default:""
Comma-separated list of repository names or regex patterns to exclude. Overrides config file.
exclude-repos: 'repo1,repo2,/^test-.*/'
Supports regex patterns using /pattern/ syntax.
​
only-repos
string
default:""
Comma-separated list of repository names to exclusively track. Overrides config file.When set, only these repositories will be tracked.
only-repos: 'my-org/repo1,my-org/repo2'
​
min-stars
number
default:""
Only track repositories with at least this many stars. Overrides config file.
min-stars: '10'

​
Data Storage

​
data-branch
string
default:"star-tracker-data"
Branch name for storing tracking data, reports, charts, and history.The action will create this branch automatically if it doesn’t exist.
​
max-history
number
default:"52"
Maximum number of snapshots to keep in history.Older snapshots are automatically removed. Default of 52 keeps approximately one year of weekly snapshots.

​
Email Notifications

​
smtp-host
string
default:""
SMTP server host for email notifications.Providing this value enables built-in email notifications.
smtp-host: 'smtp.gmail.com'
​
smtp-port
number
default:"587"
SMTP server port.Common values:
  • 587 - TLS/STARTTLS (recommended)
  • 465 - SSL
  • 25 - Unencrypted (not recommended)
​
smtp-username
string
default:""
SMTP authentication username.
smtp-username: ${{ secrets.SMTP_USERNAME }}
​
smtp-password
string
default:""
SMTP authentication password.
smtp-password: ${{ secrets.SMTP_PASSWORD }}
​
email-to
string
default:""
Email recipient address.
email-to: '[email protected]'
​
email-from
string
default:"GitHub Star Tracker"
Email sender name or address.
email-from: 'Star Tracker <[email protected]>'
​
send-on-no-changes
boolean
default:"false"
Send email even when no star changes are detected.Set to true to receive emails on every run, or false to only receive emails when changes occur.
​
notification-threshold
string
default:"0"
Star change threshold before sending notification.Options:
  • 0 - Send notification on every run with changes
  • <number> - Send only when total star delta reaches this number (e.g., 5)
  • auto - Adaptive threshold based on total star count
notification-threshold: 'auto'

​
Report Customization

​
include-charts
boolean
default:"true"
Include star trend charts in reports.Set to false to disable chart generation and reduce processing time.
​
locale
string
default:"en"
Language for reports and emails.Supported languages:
  • en - English
  • es - Spanish
  • ca - Catalan
  • it - Italian
​
top-repos
number
default:"10"
Number of top repositories to feature in charts and forecasts.Repositories are ranked by star count. Charts are generated for the top N repositories.

​
Advanced Features

​
track-stargazers
boolean
default:"false"
Track individual stargazers and show new ones in reports.Warning: Enabling this feature significantly increases API usage and execution time for repositories with many stars.
track-stargazers: 'true'

Build docs developers (and LLMs) love

Get started for freeTalk to us