DEV Community: Mehak Fatima

How to Trigger Bitrise Build from Bitbucket Pipeline?

Mehak Fatima — Wed, 13 Apr 2022 11:52:07 +0000

Hi fellow coders!
In my recent project, I felt the need to trigger Bitrise build from Bitbucket Pipeline. I hope the first question that comes in your mind would be what's the reason behind that.
so Let's see...

Motivation:
Let's suppose you have a project "abc" which contains the 3 different sub projects or folder in it.(e.g mobile, web, server)and you want to use same bitbucket repo for these 3 projects. But whenever you push some changes in web or server's folder it triggers the bitrise mobile's build which is not required.
Basically the reason behind that is whenever bitrise feels any change in bitbucket repo it starts automatic(trigger) build.
In bitrise Enable selective builds feature is not currently available for bitbucket repo.
"So our target is to run mobile build when you find changes in mobile's folder only."

Solution:
we are going to use Bitrise's api instead of automatic Bitrise’s triggers and we will hit Bitrise api endpoint through Bitbucket pipeline.

Let's start...
Trigger Bitrise using Postman (optional):
we are using postman here for testing bitrise api

You can collect slug number from Url of bitrise(https://api.bitrise.io/v0.1/apps/$Slug_number/builds).
Add Authentication token https://devcenter.bitrise.io/api/authentication/ in header of call.
Add the following object in the body of request.

const data = {
    hook_info: {
      type: 'bitrise',
      triggered_by: '',
    },
    build_params: {
      branch: 'master',
      commit_message: "",
      commit_hash: "",
      workflow_id: 'primary',
    },
  };
//Now post the api

Open bitbucket.yml file of your project in your editor.
For testing purpose, lets first create a step for Mobile Build in Bitbucket pipeline using node image.

- step:
          name: Run Android Build
          image: node:10.15.3
          script:
            - echo "Going to trigger Android Build"

If Pipeline run successfully after step 2, proceed further. If not, there is something wrong with yml file.
We will apply Change set condition on step (the step should run only if we make changes in this folder) .

- step:
          name: Run Android Build
          image: node:10.15.3
          condition:
            changesets:
              includePaths:
                - "mobile/**"
          script:
            - echo "Going to trigger Android Build"

We will Create folder inside Project with name “MobileBuilds” .
Inside the Folder we will add 2 files (Android.js ,Git.js).
Now implement these steps here.
- Get Latest git commit inside (git.js.https://dev.to/mehakfatima/how-to-get-last-git-commit-in-js-file-3il6)
- Hit bitrise api inside the Android.js (https://dev.to/mehakfatima/trigger-bitrise-build-using-bitrise-api-350p)
Invoke Android.js file from Bitbucket Pipeline. Also include required dependencies like axios and git-last-commit.

 - step:         
          name: Run Android Build
          image: node:10.15.3
          condition:
            changesets:
              includePaths:
                - "mobile/**"
          script:
            - echo "Going to trigger Android Build"
            - npm install axios
            - npm install git-last-commit
            - cd mobile/MobileBuilds
            - node Android.js $BITRISE_TOKEN

$BITRISE_TOKEN is passing value from Bitbucket’s variable to Android.js file.(https://dev.to/mehakfatima/can-we-pass-bitbucket-variables-to-js-file-hnk)
Now just run the pipeline.

Can we pass Bitbucket Variables to js File...

Mehak Fatima — Wed, 13 Apr 2022 11:39:08 +0000

Pre-Requisite:

How to use Bitbucket pipeline.
How to store Bitbucket variables.

Motivation:

As you know we can store variable inside Bitbucket repository and can use them inside the Yml file to enhance Security but can we use these variables inside js files?

let’s see…

Steps:

We can pass these variables to the file like this node Android.js $BITRISE_TOKEN.This command will run the Android.js with the parameter. we can extract this Parameter inside the file like this const buildArgs = process.argv.slice(2); buildArgs is the array here so we will extract value like this buildArgs[0] means value 1 buildArgs[1] means value 2.

Trigger Bitrise Build Using Bitrise Api

Mehak Fatima — Wed, 13 Apr 2022 11:37:25 +0000

Pre-Requisite:

what is Bitrise.
How to use Bitrise.

Motivation:
Now I can trigger bitrise builds from anywhere according to my need i am not bind.

Let’s Start…

Steps:

Create Android.js file inside the project.
Collect Authorization token from bitrise https://devcenter.bitrise.io/api/authentication/ .
Import latest git commit method .
Add following code inside the file.

const axios = require('axios');
const {lastGitCommit} = require('./Git');
const buildArgs = process.argv.slice(2);
// we have to extract first index of perameters buildArgs[0]
const headers = {
  Authorization: 'Auth Token',
};
const gitCommit = [];
const gitInfo = async () => {
  const response = await lastGitCommit();
  // console response and check if anything else you need.
  gitCommit.push(response);
  return response;
};
gitInfo();

setTimeout(function () {
  const data = {
    hook_info: {
      type: 'bitrise',
      triggered_by: 'Bitrise BUild',
    },
    build_params: {
      branch: 'master',
      commit_message: gitCommit[0].subject,
      commit_hash: gitCommit[0].hash,
      workflow_id: 'android',
    },
  };
  const post = async (url, data, headers) => {
    const payload = {
      method: 'post',
      url: url,
      headers,
      data,
    };
     const response = await axios(payload);
     return response;
  };
  const triggerNewBuild = async () => {
    let response;
    try {
      response = await post(
        'https://api.bitrise.io/v0.1/apps/slug_num/builds',
        data,
        headers,
      );
    } catch (exception) {
      error(`Error fetching All builds${exception} `);
    }
    return response;
  };
  triggerNewBuild();
}, 5000)

Run file with the command Node Android.js.

How to get Last git Commit in Js file

Mehak Fatima — Wed, 13 Apr 2022 11:35:27 +0000

Pre-Requisite:

How to use git.
Purpose of git.

Motivation:

You can collect following values inside the js file.
What is the subject of latest git commit.
what is the branch of latest git commit.
what is the hash of latest git commit and so on.

{
  "shortHash": "d2346fa",
  "hash": "d2346faac31de5e954ef5f6baf31babcd3e899f2",
  "subject": "initial commit",
  "sanitizedSubject": "initial-commit",
  "body": "this is the body of the commit message",
  "authoredOn": "1437988060",
  "committedOn": "1437988060",
  "author": {
    "name": "Ozan Seymen",
    "email": "oseymen@gmail.com"
  },
  "committer": {
    "name": "Ozan Seymen",
    "email": "oseymen@gmail.com"
  },
  "notes": "commit notes",
  "branch": "master",
  "tags": ['R1', 'R2']
}

Step:

Node provide us Library for this purpose npm i git-last-commit.
Create a file Git.js and add this function here.

const git = require("git-last-commit");
function getGitCommit() {
  return new Promise((res, rej) => {
    git.getLastCommit((err, commit) => {
      if (err) {
        return rej(err);
      } else {
        return res(commit);
      }
    });
  });
}
module.exports = {
  lastGitCommit: getGitCommit,
};

This function will return the Value of latest git commit, Call this function in other files like this.

const axios = require('axios');
const {lastGitCommit} = require('./Git');
const gitCommit = [];
const gitInfo = async () => {
  const response = await lastGitCommit();
  // console response and check if anything else you need.
  gitCommit.push(response);
  return response;
};
gitInfo();

Now just extract the values from gitCommit.
const hash= gitCommit[0].subject.