The header
The header is the picture at the top of the dashboard: Penny, the sluice gate, on a quay in one of seven states.
When more than one state applies, the first wins, in this order: failing, deploying, queued, pending, drift, first run, in sync. A busy stack, one whose lock another update held when the scan ran, makes no header failing: nothing is wrong with it, and the next scan previews it.
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. The pending, queued, deploying and failing pictures show one crate per pending stack, up to 20. Each picture has a light and a dark file, and the dashboard shows the one that matches your GitHub theme.
Every picture, one per state
Section titled “Every picture, one per state”first-runShown when the scan found no stacksin-syncShown when nothing is pending, deploying, failing or drifteddriftShown when nothing is pending, deploying or failing, and a stack changed outside the code: water seeps through the closed gate into the low downstream space, and Penny looks at it, puzzledpending-1Shown when that many stacks are pending: one crate per stackpending-4Shown when that many stacks are pending: one crate per stackpending-12Shown when that many stacks are pending: one crate per stackpending-20Shown when that many stacks are pending: one crate per stackpending-moreShown when more than 20 stacks are pending: the row of crates runs on past the left edgequeued-0Shown when a stack is queued behind its dependencies and none is deploying: the closed gate, the ticked crate tied up at it, and one crate per pending stack behind itqueued-4Shown when a stack is queued behind its dependencies and none is deploying: the closed gate, the ticked crate tied up at it, and one crate per pending stack behind itdeploying-0Shown when a stack is deploying: the open gate, one crate flowing through it, and one crate per pending stack waiting upstreamdeploying-4Shown when a stack is deploying: the open gate, one crate flowing through it, and one crate per pending stack waiting upstreamfailing-0Shown when a preview failed, or a row has a failure line: the jam, with one crate per pending stack behind itfailing-4Shown when a preview failed, or a row has a failure line: the jam, with one crate per pending stack behind it
Signs for deletes and replaces
Section titled “Signs for deletes and replaces”The pending, queued, deploying and failing pictures carry a sign when a pending, queued or deploying row has a delete or a replace.
- A replace adds the replace sign, an amber warning triangle on a pole in the water.
- A delete adds the delete sign, an amber diamond with a cross, under the replace sign.
The signs do not move, and nothing else in the picture changes.
pending-4-replacesShown when that many stacks are pending: one crate per stackWith these signs when a pending, deploying or queued row has a replace, and none has a deletepending-4-deletesShown when that many stacks are pending: one crate per stackWith these signs when one has a delete, and none has a replacepending-4-deletes-replacesShown when that many stacks are pending: one crate per stackWith these signs when there are bothfailing-4-deletes-replacesShown when a preview failed, or a row has a failure line: the jam, with one crate per pending stack behind itWith these signs when there are both
The alt text says it in words
Section titled “The alt text says it in words”Where the picture does not load, and in a screen reader, the header is its alt text. It names
the state and the pending count, Sluiceway: 4 stacks are pending, and a sign adds its fact,
, some changes delete or replace resources. A failing header names what failed and how many,
in the numbers of the counts line under it: Sluiceway: 1 preview failed,
Sluiceway: 2 previews and 1 deploy failed. The picture is the same jam for any number, so its
own label stays Sluiceway: something failed. No picture shows a busy stack, so the alt text
names it last: , 1 stack is busy.
The water rises in five steps
Section titled “The water rises in five steps”Behind the closed or jammed gate the water rises in five steps, with one amber mark each on the gauge. Behind the open gate of a deploy it stays at one level.
| Step | Pending stacks |
|---|---|
| 1 | 1 or 2 |
| 2 | 3 or 4 |
| 3 | 5 to 7 |
| 4 | 8 to 10 |
| 5 | 11 or more |
The spinner is not a header
Section titled “The spinner is not a header”A deploying or queued row starts with the spinner, a small crate on its way through the gate. It comes from the same release tag as the header, and it says only that the row’s deploy is on its way, not the state of the dashboard, so it is not in the pictures above.
A running scan is a line, not a picture
Section titled “A running scan is a line, not a picture”While a scan runs, the scan-running line under the scan line says so and links the run, from the scan’s first write until it writes the body. The header keeps the state of the last scan: a scan that is running is not a state of the stacks, and no picture is drawn for it.
Without the header
Section titled “Without the header”With dashboard.personality: false
the dashboard shows no header, no spinner and none of the voiced lines, and keeps the
counts, the rows and the plain wording.