Custom GitHub status name

[ngan]

Hi, is there a way to specify a custom GitHub status name/label for a pipeline? We’re reusing a single pipeline for various components in a monorepo that is triggered from a “main” build. Since the pipeline is reused and is for the same commit SHA, it would be nice to customize the status label on the fly through an environment variable or something. We can then declare this in the uploaded pipeline through the env key. Or better yet, a root-level github key.

For example a pipeline YML could be

[juanitofatas]

Would be great to see what the example pipeline yaml looks like!

[ngan]

Doh not sure it got but off… something like:

github:
status: “buildkite/my-custom-status”
steps:
…

Basically making “github” a top level key.

[coderanger]

Shoutout for Use step key for github status names :) It would be nice even for simple usage when using a lot of emoji.

[Rose]

Hey @ngan!

We have a secret (a.k.a. undocumented) alpha feature that might provide what you’re looking for!

You can specify a build level notify key like this:

notify:
  - github_commit_status:
      context: "whats up!!!"

steps:
...

And it will alter the github commit status label. Interpolate with env keys as you like!

You can also change this at the step like this:

steps:
  - label: "Example Script"
    command: "script.sh"
    artifact_paths: "artifacts/*"
    agents:
      queue: "default"
    notify:
      - github_commit_status:
          context: "wow example script!!"

But for that to work, you’ll need to uncheck the “Update commit statuses” checkbox on your pipeline’s repository settings page.

Hope that solves your issue! I ended up with something like this

[ngan]

Yes! That’s perfect. One question: when you said you have to uncheck “Update commit statuses,” is that for either usage or just the latter case?

[Rose]

Unchecking “Update commit statuses” is just for the latter case!

[ngan]

@Rose would it be possible to allow this notify for Trigger steps?

[sj26]

Sorry @ngan, notify isn’t supported yet on trigger steps. You can post about it in our feature requests category and we’ll keep track of it and let you know when it works:

Features