mirror of
https://github.com/tiennm99/ghstats.git
synced 2026-09-03 02:20:06 +00:00
tiennm99
d3fc27f33f
Most users reach for ghstats to show their real activity. Making the two visibility toggles opt-out rather than opt-in gives accurate stats out of the box. - -include-forks false → true - -include-private false → true - include_forks input false → true - include_private input false → true Private-repo data silently no-ops when the token lacks repo scope, so the default is safe for default github.token runs — it just won't surface more than read:user already allows. Users who want the old public-only behavior pass -include-private=false or set the Action input to "false".
70 lines
2.1 KiB
YAML
70 lines
2.1 KiB
YAML
name: ghstats
|
|
description: Generate GitHub profile summary SVG cards (profile, languages, stats, productive time)
|
|
author: tiennm99
|
|
branding:
|
|
icon: bar-chart-2
|
|
color: purple
|
|
|
|
inputs:
|
|
user:
|
|
description: GitHub username to summarize
|
|
required: true
|
|
token:
|
|
description: |
|
|
Personal access token (classic PAT) with at least `read:user` and `repo` scopes.
|
|
The default GITHUB_TOKEN works for public repos but has no access to private stats.
|
|
required: false
|
|
default: ${{ github.token }}
|
|
out:
|
|
description: Output directory for the generated SVG cards
|
|
required: false
|
|
default: output
|
|
themes:
|
|
description: Comma-separated theme ids, or `all` to render every theme
|
|
required: false
|
|
default: dracula
|
|
tz:
|
|
description: IANA timezone for the productive-time heatmap (e.g. Asia/Saigon)
|
|
required: false
|
|
default: UTC
|
|
top_repos:
|
|
description: Optional cap on seed repos probed for commit history (0 = unlimited)
|
|
required: false
|
|
default: "0"
|
|
commits_per_repo:
|
|
description: Max commits sampled per repo (covers last-year and all-time aggregates)
|
|
required: false
|
|
default: "500"
|
|
include_forks:
|
|
description: Include forked repos in stats and commit probing
|
|
required: false
|
|
default: "true"
|
|
include_private:
|
|
description: Include private repos (requires PAT with repo scope; silently no-op otherwise)
|
|
required: false
|
|
default: "true"
|
|
commit_changes:
|
|
description: Whether to commit the generated cards back to the repo
|
|
required: false
|
|
default: "false"
|
|
commit_message:
|
|
description: Commit message used when commit_changes is true
|
|
required: false
|
|
default: "chore: update ghstats cards"
|
|
commit_branch:
|
|
description: Branch to commit to (defaults to the current ref)
|
|
required: false
|
|
default: ""
|
|
author_name:
|
|
description: Git author name for auto-commit
|
|
required: false
|
|
default: "github-actions[bot]"
|
|
author_email:
|
|
description: Git author email for auto-commit
|
|
required: false
|
|
default: "41898282+github-actions[bot]@users.noreply.github.com"
|
|
|
|
runs:
|
|
using: docker
|
|
image: Dockerfile
|