docs icon indicating copy to clipboard operation
docs copied to clipboard

Messaging around possible differences in state expectations

Open mcncl opened this issue 1 year ago • 1 comments

Why

The possible build states are not the states that will be returned by state in the API.

Eg, a blocked build could return state as passed, but would return blocked as true.

mcncl avatar Jul 26 '24 01:07 mcncl

Preview URL: https://2909--bk-docs-preview.netlify.app

buildkite-docs-bot avatar Jul 26 '24 01:07 buildkite-docs-bot

Hi again @mcncl ,

In order to improve the discoverability of this information, I've added this info to the existing callout in the reused descriptions throughout other relevant areas of the docs (i.e. the Notifications and Defining steps pages within the Configuring pipelines section of the Pipelines docs), since there are links to these sections where surfacing this idiosyncratic behaviour would be useful.

Anyway, I shall approve and merge this PR now, but if you have any concerns about these additional changes, please do let me know!

gilesgas avatar Aug 11 '24 23:08 gilesgas