The Step pauses the current build until another running build or builds are finished. The Step checks statuses of the builds defined in the Step. The builds are defined in the Build slugs input: you can add these slugs manually but the typical use case is to use the Environment Variable exported by the Bitrise Start Build Step.
As long as the builds defined by the slugs are running, the Step will hold the build it is running in. The build will fail if any of the builds included in the Step fail.
Configuring the Step
Before you run a build with this Step, make sure you have your Personal Access Token stored in a Secret Environment Variable.
This Step is generally used in combination with the Bitrise Start Build Step which starts other builds in parallel with the current one. The build that triggered the parallel builds needs to wait for those builds to finish in order to report a successful or a failed build: this Step ensures the build is on hold until the other builds are finished.
- Set up at least two Workflows in the Workflow Editor: one will contain the Step, the other will be triggered by the Step.
You can set up as many Workflows as you wish: your number of concurrencies limit the number of Workflows you can run simultaneously.
- Add the Bitrise Start Build Step to the part of the Workflow where you want to trigger another build.
- Add the Secret Env Var storing your Personal Access Token to the Bitrise Access Token input of the Bitrise Start Build Step: click the Select secret variable button, and choose the key you created.
- Find the Workflows input of the Bitrise Start Build Step, and add the Workflow(s) you want to run.
- In the Environments to share input, add Environment Variables (Env Vars) that you want to share between the builds triggered by the Step.
- Optionally, you can add any Step you would like to run in parallel while the triggered Workflow(s) are running in the parent Workflow.
- Add the Bitrise Wait for Build Step to the end of Workflow that contains the Bitrise Start Build Step.
- Add the Secret Env Var storing your Personal Access Token to the Bitrise Access Token input of the Bitrise Wait for Build Step: click the Select secret variable button, and choose the key you created.
- In the Build slugs input, define the builds for the Step.
The build slugs you need are stored by the Bitrise Start Build Step in the
$ROUTER_STARTED_BUILD_SLUGS Env Var. As long as the builds defined by the slugs are running, the Step will hold the build it is running in. The build will fail if any of the builds included in the Step fail.
- Optionally, you can save the build artifacts from the builds and configure the Step to abort all builds if any of the builds fail:
- In The path of the build artifacts input, set where you'd like to save the artifacts.
- Set the Abort all builds if one fails input to either
yes or no.
Troubleshooting
- Make sure you have both the Bitrise Start Build and the Bitrise Wait for Build Steps in the right place in your initial Workflow.
- Your Personal Access Token can expire! Make sure it's still valid - without it, you can't start new builds with this Step.
Useful links
Related Steps