Nitro build system

Build React Native projects using Nitro build system

Description

This step allows you to easily run the Nitro builder by providing input parameters in a friendly way.

🧩 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
platform	The target platform you want to build.	required
project_id	A string to indetify the project	required	$BITRISE_APP_URL
build_id	A string to indetify the build number	required	$BITRISE_BUILD_SLUG
output_directory	The path to the directory where to place all of Nitro's output files		$BITRISE_DEPLOY_DIR
root_directory	The directory within your project, in which your code is located. Leave this field empty if your code is not located in a subdirectory.		$NITRO_ROOT_DIRECTORY
debug	Enable verbose logs		no
fail_safe	Runing the app in this mode allows you to prevent the build to fail but you can check the status in further steps.
version_name	The version name for the app
version_code	The version code for the app
entry_file	The entry file for bundle generation		$ENTRY_FILE
custom_ssh_key_url	If provided will add a new key to the ssh agent.
disable_cache	When setting this option to yes build cache optimizations won't be performed.		no
app_label	The application label displayed in the mobile app. Defaults to the name field of the package.json file.
cache_provider	Choose the provider where cache artifacts will be persisted: - fs: File system. - s3: Amazon - Simple Storage Service. - azure: Microsoft - Azure Blob Storage.		s3
exclude_modified_files	If you modify or delete files right after cloning your repository those changes won't impact on your build.		no
env_var_lookup_keys	A list of env variable keys to lookup in order to determine whether the build should be cached or not.
cache_env_var_lookup_keys	A list of env variable keys to lookup in order to determine whether the build should be cached or not.
cache_file_lookup_paths	A list of paths (relative to the root of the repo or absolute) to lookup in order to determine whether the build should be cached or not.
experimental_metro_cache_enabled	When enabling this the build will try to take advantage of the React Native Metro cache.
pre_install_command	Run command prior to install project dependencies (e.g. rm -rf ./some-folder)
pre_build_command	Run command prior to start building the app (e.g. yarn tsc && yarn test)
post_build_command	Run command once build successfully finished (e.g. yarn publish)
android_flavor	Flavor
android_keystore_url	Keystore url		$BITRISEIO_ANDROID_KEYSTORE_URL
android_keystore_password	Keystore password	sensitive	$BITRISEIO_ANDROID_KEYSTORE_PASSWORD
android_keystore_key_alias	Keystore alias		$BITRISEIO_ANDROID_KEYSTORE_ALIAS
android_keystore_key_password	Keystore key password	sensitive	$BITRISEIO_ANDROID_KEYSTORE_PRIVATE_KEY_PASSWORD
ios_scheme	The name of the ios scheme
ios_certificate_url	The url to download and install the certificate
ios_certificate_passphrase	Certificate passphrase	sensitive
ios_codesigning_identity	Codesigning identity
ios_provisioning_profile_urls	A string containing a '|' separated values where provisioning profiles are located e.g. url1|url2|url3
ios_provisioning_profile_specifier	The name of the provisioning profile when using a single one
ios_xcconfig_path	The path relative to project root directory where the custom .xcconfig file is located
ios_team_id	Specify the Team ID you want to use for the Apple Developer Portal
ios_export_method	The export method used to generate the IPA		ad-hoc
aws_s3_access_key_id	Access Key Id		$NITRO_AWS_ACCESS_KEY_ID
aws_s3_secret_access_key	Secret Access Key		$NITRO_AWS_SECRET_ACCESS_KEY
aws_s3_region	AWS Region		$NITRO_AWS_S3_REGION
aws_s3_bucket	Bucket name		$NITRO_AWS_S3_BUCKET
nitro_bin_file_path	Nitro binary location (by default it downloads the binary matching with the step version)

Outputs

Environment Variable	Description
NITRO_OUTPUT_DIR	The path to the directory where to place all of Nitro's output files
NITRO_LOGS_PATH	The full path to access the build log
NITRO_DEPLOY_PATH	The full path to access the build artifacts

🙋 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