steps-yarn

README

Run yarn command

Runs yarn with the given command and args.

Description

Yarn is a package manager that is compatible with the npm registry. Download your app's dependencies via yarn by using this Step.

Configuring the Step

To use the Step, you need to configure your dependencies in your package.json file.

1. Set a command in The yarn command to run input.

   If you leave the input blank, the Step will simply install your dependencies. You can find the other available command in yarn's documentation.

2. Set the arguments in the Arguments for running yarn commands input.

   You can specify multiple arguments. Check out the available arguments for each command in yarn's documentation.

You can also cache the contents of the node_modules directory by setting the Cache node_modules input to yes.

Troubleshooting

If the Step fails, run it again with verbose logging enabled. To do so, set the Enable verbose logging input to yes. Doing so allows yarn to output more information about the command you ran.

Make sure your commands and arguments are correct, and that your packages are correctly defined in the package.json file.

Useful links

Getting started with React Native apps Running Detox tests on Bitrise

Related Steps

Run Cocoapods install Run npm command

🧩 Get started

Add this step directly to your workflow in the Bitrise Workflow Editor.

You can also run this step directly with Bitrise CLI.

⚙️ Configuration

Inputs

Key	Description	Flags	Default
workdir	Working directory of the step. You can leave it empty to not change it.		$BITRISE_SOURCE_DIR
command	Specify the command to run with yarn. For example add. Leave it blank to install dependencies.
args	Arguments are added to the yarn command. You can specify multiple arguments, separated by a space character. For example react or -dev
cache_local_deps	Select if the contents of node_modules directory should be cached. yes: Mark local dependencies to be cached. no: Do not use cache. All node_modules folders (recursively) located under the working directory will be cached.	required	no
verbose_log	Choose if debug logging is enabled.	required	no

Outputs

There are no outputs defined in this step

🙋 Contributing

We welcome pull requests and issues against this repository.

For pull requests, work on your changes in a forked repository and use the Bitrise CLI to run step tests locally.

Learn more about developing steps:

• Create your own step
• Testing your Step