Files
tiennm99 1763422570 feat(card): configurable start of week (#25)
* feat(card): configurable start of week for heatmap + weekday cards

New -start-of-week CLI flag (and start_of_week action input) rotates the
contribution-heatmap rows and the productive-weekday bars so users whose
calendars start on Monday (or any other day) get matching output. Default
stays Sunday to preserve existing renders.

* docs: note start-of-week in design-guidelines, codebase-summary, deployment-guide

- design-guidelines: heatmap row order + productive-weekday bar order now derive from Profile.WeekStart
- codebase-summary: list new weekday_start_test.go cases + TestParseWeekday
- deployment-guide: mention start_of_week as an optional action input in the workflow template
2026-04-21 20:57:21 +07:00

74 lines
2.3 KiB
YAML

name: ghstats-cards
description: Generate GitHub profile summary SVG cards (profile, languages, stats, productive time, contributions)
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
start_of_week:
description: First day of week for heatmap rows and weekday bars (sunday|monday|tuesday|…)
required: false
default: sunday
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