This is a basic demonstration of what is needed to run a Bitbucket Pipelines CI build by calling their REST API.
We are using Figmagic for this demo, to demonstrate running it in CI. Even if you don't care for that specific tool, you'll get the gist how to automate stuff in CI here.
I am assuming that you will set up a repo in Bitbucket with the provided pipeline. If you have not, do so as the first step.
Set up Repository Variables as per:
FIGMA_TOKENas your Figma API tokenFIGMA_URLto point to your Figma file ID
Set both to be secret values.
The ideal use seems to be to use an application password, instead of any personal credentials.
To do this, first create an app password. You will need the token (password) and your Bitbucket username (you can see it in the Account Settings page; it's not your email!) for authenticating.
You will do a POST request. Set the following header:
Content-Type: application/json.
For authentication, in case you use a client like Insomnia, just use the built-in functionality to use Basic auth and set username and password there. For a curl solution to this, see the reference links.
POST https://api.bitbucket.org/2.0/repositories/YOUR_WORKSPACE_OR_USER/YOUR_REPO/pipelines/#post
{
"target": {
"ref_type": "branch",
"type": "pipeline_ref_target",
"ref_name": "main"
}
}ref_name should match your branch name.
This is same as above, but you should also pass variables in your payload. Use whatever you need for key and value. Using secure will attempt to mask the value in logs.
POST https://api.bitbucket.org/2.0/repositories/YOUR_WORKSPACE_OR_USER/YOUR_REPO/pipelines/#post
{
"target": {
"ref_type": "branch",
"type": "pipeline_ref_target",
"ref_name": "main"
},
"variables": [{
"key": "FIGMA_VERSION",
"value": "something-here-alright",
"secured": false
},
{
"key": "FIGMA_MESSAGE",
"value": "This is what happened",
"secured": false
}]
}