Skip to content

github_action_status

The latest CI workflow run for a repo as a pass/fail badge or short text line. Use github_action_history for a series of recent runs rather than the single most recent one.

Kind	Safety	Shapes
cached	Safe	`badge`, `text`, `entries`

Options

Option	Type	Required	Default	Description
`repo`	"owner/name"	no	git remote of cwd	Repository to query.
`branch`	string	no	—	Branch to filter the latest run by. Omit for the most recent run on any branch.

Compatible renderers

Shape	Renderers
`badge`	`animated_boot`, `animated_postfx`, `animated_scanlines`, `animated_splitflap`, `animated_wave`, `status_badge`
`text`	`animated_boot`, `animated_figlet_morph`, `animated_postfx`, `animated_scanlines`, `animated_splitflap`, `animated_typewriter`, `animated_wave`, `text_ascii`, `text_plain`
`entries`	`animated_boot`, `animated_postfx`, `animated_scanlines`, `animated_splitflap`, `animated_wave`, `grid_table`

Preview

`badge` via `status_badge`

● ci passing

[[widget]]
id = "github_action_status"
fetcher = "github_action_status"
render = "status_badge"

`text` via `text_ascii`

         ▀                                   ▀                                  
█▄█▖▝▀▙ ▝█  █▀▙      ▗▖     ▜▞▜▖▝▀▙ ▟▀▀ ▟▀▀ ▝█  █▀▙ ▟▀▟▘                        
█▜▜▌▟▀█  █  █ █      ▝▘     ▐▙▟▘▟▀█ ▝▀▙ ▝▀▙  █  █ █ ▜▄█                         
▀ ▝▘▝▀▝▘▝▀▘ ▀ ▀             ▟▙  ▝▀▝▘▀▀▘ ▀▀▘ ▝▀▘ ▀ ▀ ▄▄▛

[[widget]]
id = "github_action_status"
fetcher = "github_action_status"
render = "text_ascii"

`text` via `text_plain`

main · passing

[[widget]]
id = "github_action_status"
fetcher = "github_action_status"
render = "text_plain"

`entries` via `grid_table`

status                           passing
branch                              main
conclusion                       success

[[widget]]
id = "github_action_status"
fetcher = "github_action_status"
render = "grid_table"