You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
ghashboard
v0.0.8-release
A tool for making dashboard pages with all the badges from your Github Actions.
It is pronounced (in an upper-crust accent) "gosh-board", not "gashboard" like some sort of horror flick.
Recursion detected: Stack overflow! ...just kidding! This is actually a great way to run it.
It works really well to as a generator for Github profiles (example: code and result).
Download the latest version from the Github Releases page
A sample command:
export GITHUB_TOKEN=$(gh auth token)
ghashboard --owners=google,spf13
Either as inputs for the Github Action or flags for the CLI.
Note: either owners
or repos
is required.
Name | Description |
---|---|
archived |
include archived repos? (default is false ) |
empty |
include repos with no workflows: useful if you have external badges (default is false ) |
exclude |
workflows to exclude (comma-separated list) |
externals |
external badges (list) to include. Note that these usually only work with public repos |
footer |
footer text |
forks |
include forked repos? |
format |
output format: csv , markdown or json . json is good for debugging. (default is markdown ) |
header |
header text |
inactive |
include inactive workflows? |
include |
workflows to include: others will be skipped (comma-separated list)) |
log-level |
log level: debug , info , warn or error |
output |
output file to create (or - for stdout) |
owners |
list of owners |
private |
include private repos? (one of public |
public |
include public repos? (one of public |
repos |
list of repos |
skip |
exclude specific repos (use owner/name ) |
title |
title text |
token |
Github token: not absolutely required, but you will run into rate-limits without one |
See run.sh
for how I run it during development.
Contributions welcome!
- GoReleaser - packaging for release
- Steve Francia - viper
- Steve Francia - cobra
- See
go.mod
for other golang modules used - jq - JSON manipulation
- cb - clipboard utility