Skip to main content
Sign in

Customizing the function of a Bitrise Step

Matthew Jones
  • Updated

Issue:

One of the Bitrise Steps comes close to doing what I want, but I'd like to tweak something. How do I change a Step's behavior beyond the options presented in the Workflow Editor?

Possible solutions:

Bitrise and all of its Steps are open source! You can fork any Step, make changes to it, and import the Step to your Workflow. Here's how you do it.

  1. Find the Step you want to fork on the Bitrise Integrations Page (or in the Workflow Editor).

  2. On the Step's page, you'll find a Github Source button. Click that.

    Screen_Shot_2020-11-24_at_1.01.22_PM.png

  3. On the Step's Github page, click the Fork button.

    Screen_Shot_2020-11-24_at_1.01.50_PM.png

  4. Clone your forked repo and make any necessary changes.

    Be sure to take a look at the step.yml file. You'll want to make some changes here related to your fork. At the bare minimum you should update the title and description.

  5. Push your changes to the forked repo on Github.

  6. Add the Step to your workflow using the bitrise.yml file. The format will look similar to the following:

    format_version: 9
workflows:
     primary:
     steps:
     - git::<Your Github Repo URL>.git:
          title: "<Your Step Title>"

  7. Do a test run of your Workflow using the new Step.

Additional information: