How to get build status in a Bamboo build task script?

[Hélène_Droal]

Hello,

I would like to call the github API at the end of the build in order to tell him if the build was successfull or not.

I've created a final task for this but I can't find a bamboo variable who contains the build state.

Could you help me?

Thanks :)

Hélène

[Hélène_Droal · Accepted solution]

Okay so I found the perfect variable (undocumented) : `bamboo_jobFailed` :)

[Bharath_Venkat_Rajan]

Exactly what I wanted. Thanks @Hélène_Droal 

[Elizabeth Goldstein]

Thank you @Hélène_Droal this is going to save me a headache with the API! 

[Vigneshwaran UK]

Can someone please share the api, it would be helpful for me.
Iam searching it for past week couldn't able to get the proper one.
Thanks

[PatrickS]

Github Commit Status API:

https://docs.github.com/en/rest/commits/statuses#create-a-commit-status

Script Task in Bamboo:

REPO="repo-owner/my-repo-name"

if [[ "$bamboo_jobFailed" == "false" ]]
then
    STATE=success
else
    STATE=failure
fi

DATA="{\"state\":\"$STATE\",\"target_url\":\"$bamboo_buildResultsUrl\",\"description\":\"Bamboo build succeeded!\",\"context\":\"default\"}"

curl -L \
    -X POST \
    -H "Accept: application/vnd.github+json" \
    -H "Authorization: Bearer $bamboo_github_token"\
    -H "X-GitHub-Api-Version: 2022-11-28" \
    "https://api.github.com/repos/$REPO/statuses/$bamboo_repository_revision_number" \
    -d "$DATA"

[Phill Pafford]

looks like there was a syntax update to reference the variable, example script

${bamboo_jobFailed} instead of $bamboo_jobFailed

#!/usr/bin/env bash

## bamboo does not catch some script failures unless this flag is set

set -e

TASK="CHECK BUILD STATUS"

echo ================== START $TASK ==================

## bamboo_jobFailed is a boolean

BUILD_STATUS=${bamboo_jobFailed}

if [[ "$BUILD_STATUS" == "true" ]]

then

  echo "the build has failed"

else

  echo "the build is passing"

fi

echo =================== END $TASK ===================

[Alexey Chystoprudov]

I would suggest to install this plugin: https://github.com/HackAttack/bamboo-github-status