Repository files navigation

This script will try to merge two branches or create a Pull-Request on Github if there's a conflict.

Can be run directly with thebitrise CLI,justgit clone this repository,cd into it's folder in your Terminal/Command Lineand callbitrise run test.

Check thebitrise.yml file for required inputs which have to beadded to your.bitrise.secrets.yml file!

Step by step:

1. Open up your Terminal / Command Line
2. git clone the repository
3. cd into the directory of the step (the one you justgit cloned)
4. Create a.bitrise.secrets.yml file in the same directory ofbitrise.yml(the.bitrise.secrets.yml is a git ignored file, you can store your secrets in it)
5. Check thebitrise.yml file for any secret you should set in.bitrise.secrets.yml

• Best practice is to mark these options with something like# define these in your .bitrise.secrets.yml, in theapp:envs section.

7. Once you have all the required secret parameters in your.bitrise.secrets.yml you can just run this step with thebitrise CLI:bitrise run test

An example.bitrise.secrets.yml file:

envs:- A_SECRET_PARAM_ONE: the value for secret one- A_SECRET_PARAM_TWO: the value for secret two

1. Create a new git repository for your step (don't fork thestep template, create anew repository)
2. Copy thestep template files into your repository
3. Fill thestep.sh with your functionality
4. Wire out your inputs tostep.yml (inputs section)
5. Fill out the other parts of thestep.yml too
6. Provide test values for the inputs in thebitrise.yml
7. Run your step withbitrise run test - if it works, you're ready

For Step development guidelines & best practices check this documentation:https://github.com/bitrise-io/bitrise/blob/master/_docs/step-development-guideline.md.

NOTE:

If you want to use your step in your project'sbitrise.yml:

1. git push the step into it's repository
2. reference it in yourbitrise.yml with thegit::PUBLIC-GIT-CLONE-URL@BRANCH step reference style:

- git::https://github.com/user/my-step.git@branch:   title: My step   inputs:   - my_input_1: "my value 1"   - my_input_2: "my value 2"

You can find more examples of step reference stylesin thebitrise CLI repository.

1. Fork this repository
2. git clone it
3. Create a branch you'll work on
4. To use/test the step just follow theHow to use this Step section
5. Do the changes you want to
6. Run/test the step before sending your contribution

• You can also test the step in yourbitrise project, either on your Mac or onbitrise.io
• You just have to replace the step ID in your project'sbitrise.yml with either a relative path, or with a git URL format
• (relative) path format: instead of- original-step-id: use- path::./relative/path/of/script/on/your/Mac:
• direct git URL format: instead of- original-step-id: use- git::https://github.com/user/step.git@branch:
• You can find more example of alternative step referencing at:https://github.com/bitrise-io/bitrise/blob/master/_examples/tutorials/steps-and-workflows/bitrise.yml

7. Once you're done just commit your changes & create a Pull Request

You can share your Step or step version with thebitrise CLI. If you use thebitrise.yml included in this repository, all you have to do is:

1. In your Terminal / Command Linecd into this directory (where thebitrise.yml of the step is located)
2. Run:bitrise run test to test the step
3. Run:bitrise run audit-this-step to audit thestep.yml
4. Check theshare-this-step workflow in thebitrise.yml, and fill out theenvs if you haven't done so already (don't forget to bump the version number if this is an updateof your step!)
5. Then run:bitrise run share-this-step to share the step (version) you specified in theenvs
6. Send the Pull Request, as described in the logs ofbitrise run share-this-step

That's all ;)