Skip to content
sluiceway

The header

The header is the picture at the top of the dashboard: Penny, the sluice gate, on a quay in one of five states. When more than one applies, the first wins, in this order: failing, deploying, pending, drift, first run, in sync.

Upstream is on the left, where crates pile up while changes are pending. Downstream is on the right, where the water runs while a stack deploys. Each picture has a light and a dark file, and the dashboard shows the one that matches your GitHub theme.

The pictures

Section titled “The pictures”
  • Penny beside an empty channel: the scan found no stacksPenny beside an empty channel: the scan found no stacks

    first-runShown when the scan found no stacks

  • Penny resting on a calm quay because every stack is in syncPenny resting on a calm quay because every stack is in sync

    in-syncShown when nothing is pending, deploying, failing or drifted

  • 1 stack is pending: one crate waits upstream of Penny1 stack is pending: one crate waits upstream of Penny

    pending-1Shown when that many stacks are pending: one crate per stack

  • 4 stacks are pending: four crates wait upstream of Penny4 stacks are pending: four crates wait upstream of Penny

    pending-4Shown when that many stacks are pending: one crate per stack

  • 12 stacks are pending: twelve crates wait upstream of Penny12 stacks are pending: twelve crates wait upstream of Penny

    pending-12Shown when that many stacks are pending: one crate per stack

  • More than 12 stacks are pending: the row of crates runs past the left edgeMore than 12 stacks are pending: the row of crates runs past the left edge

    pending-moreShown when more than 12 stacks are pending: the row of crates runs on past the left edge

  • A stack is deploying: the gate is open and water runs downstreamA stack is deploying: the gate is open and water runs downstream

    deployingShown when a stack is deploying

  • Something failed: the gate is stuck half open over a log, with a red lampSomething failed: the gate is stuck half open over a log, with a red lamp

    failingShown when a preview failed, or a row has a failure line

With the destroy sign

Section titled “With the destroy sign”

When a pending or deploying row deletes or replaces a resource, the pending and deploying pictures carry the destroy sign: an amber warning triangle on a pole in the water. It does not move, and nothing else in the picture changes.

  • 4 stacks are pending, some delete or replace resources: the destroy sign stands in the water4 stacks are pending, some delete or replace resources: the destroy sign stands in the water

    pending-4-destroysShown when the header state is pending, and a pending row has a delete or replace

  • A stack is deploying, and some changes delete or replace resources: the destroy sign stands in the waterA stack is deploying, and some changes delete or replace resources: the destroy sign stands in the water

    deploying-destroysShown when the header state is deploying, and a pending or deploying row has a delete or replace

Water steps

Section titled “Water steps”

The water upstream of Penny rises in five steps, with one amber mark each on the gauge.

StepPending stacks
11 or 2
23 or 4
35 to 7
48 to 10
511 or more

Without the header

Section titled “Without the header”

With dashboard.personality: false the dashboard shows no header and none of the two voiced lines, and keeps the counts, the rows and the plain wording.