Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
activity

GitHub Action

ghashboard

v0.0.8-release

ghashboard

activity

ghashboard

Builds dashboard pages with your Github Action badges

Installation

Copy and paste the following snippet into your .yml file.

              

- name: ghashboard

uses: fileformat/[email protected]

Learn more about this action in fileformat/ghashboard

Choose a version

Github Actions Dashboard (aka ghashboard) Ghashboard Logo

build release Version

A tool for making dashboard pages with all the badges from your Github Actions.

Examples

VectorLogoZone example External badges example

Pronunciation

It is pronounced (in an upper-crust accent) "gosh-board", not "gashboard" like some sort of horror flick.

Using via Github Actions

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).

Using via CLI

Download the latest version from the Github Releases page

A sample command:

export GITHUB_TOKEN=$(gh auth token)
ghashboard --owners=google,spf13

Options

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

Developing

See run.sh for how I run it during development.

Contributing

Contributions welcome!

License

MIT

Credits

Git Github golang Google Noto Emoji Markdown Shields.IO VectorLogoZone