Apologies if this has been asked before but I couldn’t find any relevant answers.
I’m wondering if there’s a way to modify the text on the Unblock this step? popup in a block step? Unless I’ve missed something here there are attributes to set the text (i.e. hint) in input-capturing block steps but couldn’t find if this text on the actual confirmation popup can be modified at all.
For example, consider the following block:
- if: build.branch == pipeline.default_branch
block: ":unlock: Please, check the verification result at https://buildkite.com/.../builds/${BUILDKITE_TRIGGERED_FROM_BUILD_NUMBER}#verification-result :scales:"
key: unblock-deployment
depends_on:
- some_dependency
where the text with the resolved url are shown on the step but naturally that’s just (mostly hidden) text and the url is certainly not clickable.
So, I’m wondering if there’s any configuration which can be used to display that text (with a clickable url) on the confirmation popup instead of the Unblock this step? one?
Maybe asking too much but thought I’d give it a try.
Thanks for reaching out. At the moment, there’s no way to get a clickable link into the “Unblock this step?” confirmation popup.
One thing that will help though is to use prompt instead of block for the message you want people to see before they unblock. Right now your text is in block, which only becomes the step’s label on the pipeline graph and gets truncated there. Moving it to prompt puts it in the actual popup body
instead, which is more visible and easier to copy.
If having an actually-clickable link matters, a build annotation (buildkite-agent annotate, which does render Markdown) posted by a step just
before the block step would put a clickable link right next to the blocked step in the build view.
Please reach out if you have any further questions!
The prompt step looks pretty nice and does indeed display the desired message in a more intuitive manner.
Did try the buildkite-agent annotate command to create the link and it does work quite nicely too. The only caveat I think is the fact that the actual (clickable) link is shown at the top of the build page rather than at the actual place within the steps where it is declared so it can make it slightly harder for users to spot that (especially if the pipeline contains many steps).
Glad to hear you found success with the annotation! If you’re using the New Build Experience, you can actually scope an annotation with --scope job to display the annotation against the job directly, opposed to at the top of the build
