highlyavailable/GitHub README Dashboard

OSS contributor dashboard generator. Maintains live activity, review, and bookkeeping sections in any markdown file.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
github_tokenGitHub token for API access. A fine-grained PAT with repo:read and pull-requests:read is required for cross-repo visibility. The default GITHUB_TOKEN is limited to the current repository.yes
usernameGitHub username to build the dashboard for. Defaults to the repository owner.no${{ github.repository_owner }}
sectionsComma-separated list of dashboard sections to render. Available: standup, open_prs, response_inbox, review_inbox, recent_activity, activity_feed, merged_prs, stats, pinned_prs, stale_prs, failing_ci, ready_to_merge, velocity_chart, commit_heatmap, streak.noopen_prs,response_inbox,review_inbox,recent_activity
target_fileMarkdown file to update.noREADME.md
commit_messageCommit message for the update.nochore: update readme dashboard
commit_nameCommitter name.nogithub-actions[bot]
commit_emailCommitter email.no41898282+github-actions[bot]@users.noreply.github.com
commitWhether the action should commit and push changes. Set to false to let downstream steps handle the commit.notrue
config_filePath to a YAML file with per-section rendering config (style, columns, status labels, date format, empty state). Inline inputs win over the file. Missing file is treated as empty config.no.github/readme-dashboard.yml
status_labelsJSON object overriding status tag text. Example: {"merged":"merged","open":"open","draft":"wip"}. Overrides values from config_file.no
date_formatHow dates are rendered: relative (default), absolute (YYYY-MM-DD), or both.norelative
themeVisual theme for every section. "default" uses emoji status icons; "minimal" strips all emoji for a clean, plain-text dashboard. Per-section override and custom status_labels still win over the theme.nodefault
max_rowsDefault cap on rows rendered per section.no10
include_draftsInclude draft pull requests in PR-based sections.nofalse
repositoriesComma-separated owner/repo list to scope every section to. Empty means all repos visible to the token.no
exclude_repositoriesComma-separated owner/repo list to exclude from every section.no
activity_days[recent_activity] Days of comment history to include.no14
merged_window_days[merged_prs] Look-back window in days for merged PRs. Set to 0 to show all merged PRs with no time limit.no90
activity_feed_days[activity_feed] Optional look-back window in days for the public activity timeline. 0 (default) shows the most recent events regardless of age.no0
activity_feed_types[activity_feed] Comma-separated event types to include (e.g. PullRequestEvent, IssueCommentEvent, PushEvent, WatchEvent). Empty uses a sensible default set.no
activity_feed_repositories[activity_feed] Comma-separated owner/repo list to scope the activity feed to specific repositories. Merges with the global repositories filter. The Events API does not support server-side filtering, so this is applied client-side.no
activity_feed_exclude_repositories[activity_feed] Comma-separated owner/repo list to exclude from the activity feed. Additive with the global exclude_repositories. Applied client-side after fetching events.no
recent_activity_exclude_repositories[recent_activity] Comma-separated owner/repo list to exclude from the recent activity section only. Additive with the global exclude_repositories.no
stats_periods[stats] Comma-separated periods to report. Any of: week, month, quarter, year.noweek,month,year
stale_days[stale_prs] Days of inactivity before a PR is considered stale.no14
velocity_weeks[velocity_chart] Number of weeks to plot.no12
heatmap_months[commit_heatmap, streak] Months of contribution history to include.no12
standup_layout[standup] Comma-separated list of blocks. Available: hero, needs_attention, open_prs, recently_merged, stale_prs, failing_ci, ready_to_merge, response_inbox, review_inbox, activity_feed. Default: hero,needs_attention,open_prs,recently_merged,response_inbox,review_inbox,activity_feed.no
standup_rows[standup] Per-block row cap for embedded tables.no5
standup_orgs[standup] Comma-separated GitHub orgs to render separate sub-dashboards for. Each org gets its own hero + needs_attention + tables, scoped via `org:<name>` in queries. Empty means a single global view.no
disable_pat_warning[standup] Suppress the PAT-missing banner even when the action detects a bot token.nofalse
open_prs_show_ci[open_prs] When true, include per-PR CI status in the State column. Adds 1 REST call per PR.nofalse
viz_styleDefault visualization style for chart sections: mermaid (default), unicode, or both. Per-section override goes in config_file.nomermaid
pinned_prs_state[pinned_prs] Filter PRs by state: open, closed, merged, all.noall
pinned_prs_start_date[pinned_prs] Start date for PR filtering (YYYY-MM-DD).no
pinned_prs_end_date[pinned_prs] End date for PR filtering (YYYY-MM-DD).no
pinned_prs_blacklist[pinned_prs] Comma-separated PR numbers to exclude.no
pinned_prs_sort_by[pinned_prs] Sort key: created, updated, popularity.noupdated
namedescription
updatedtrue if the target file was modified.
sections_renderedComma-separated list of sections that rendered successfully.
sections_failedComma-separated list of sections that failed to render.