Skip to content

Latest commit

 

History

History
86 lines (67 loc) · 5.78 KB

README.md

File metadata and controls

86 lines (67 loc) · 5.78 KB

Nitro for iOS

Step changelog

Build your React Native app faster than ever with Nitro

Description

This step builds your React Native app for iOS using Nitro. Get your API key on our website.

🧩 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
api_key The API key required by Nitro. It is recommended to set a $NITRO_API_KEY as a Bitrise secret. sensitive
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 ./
scheme The name of the iOS scheme
build_configuration The name of the active build configuration Release
xcconfig_path The path relative to project root directory where the custom .xcconfig file is located
version_name The version name for the app
version_code The version code for the app
disable_version_name_from_package_json By default will get the 'version' field from package.json and set the version name no
disable_version_code_auto_generation By default will generate a timestamp based number and set the version code no
certificate_url The url to download and install the certificate
certificate_passphrase Certificate passphrase sensitive
codesigning_identity Codesigning identity
provisioning_profile_urls A string containing a '|' separated values where provisioning profiles are located e.g. url1|url2|url3
provisioning_profile_specifier The name of the provisioning profile when using a single one
team_id Specify the Team ID you want to use for the Apple Developer Portal
export_method The export method used to generate the IPA ad-hoc
cache_provider Choose the provider where cache artifacts will be persisted: - fs: File system - s3: Amazon - Simple Storage Service s3
disable_cache When setting this option to yes build cache optimizations won't be performed. (defaults to $NITRO_DISABLE_CACHE if present)
cache_env_var_lookup_keys A list of | separated values with env variable keys to lookup to determine whether the build should be cached or not
cache_file_lookup_paths A list of | separated value paths (relative to the root of the repo or absolute) to lookup in order to determine whether the build should be cached or not
disable_metro_cache Setting this field to yes will disable the React Native Metro cache feature. (defaults to $NITRO_DISABLE_METRO_CACHE if present)
aws_s3_access_key_id AWS access key ID for S3 bucket build caching. (defaults to $NITRO_AWS_S3_ACCESS_KEY_ID if present)
aws_s3_secret_access_key AWS secret access key for S3 bucket build caching. (defaults to $NITRO_AWS_S3_SECRET_ACCESS_KEY if present)
aws_s3_region AWS region where S3 bucket for build caching is located. (defaults to $NITRO_AWS_S3_REGION if present)
aws_s3_bucket AWS bucket name for S3 bucket build caching. (defaults to $NITRO_AWS_S3_BUCKET if present)
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)
detox_configuration Select a device configuration from your defined configurations.
output_directory The path to the directory where to place all of Nitro's output files. (defaults to $BITRISE_DEPLOY_DIR)
entry_file The entry file for bundle generation. (defaults to $ENTRY_FILE if present)
verbose Enable verbose logs no
debug Enable step debugging 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. (defaults to $NITRO_FAIL_SAFE if present)
Outputs
Environment Variable Description
NITRO_BUILD_STATUS The status of the latest build (success / failure)
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_SUMMARY_PATH The full path to access the build summary report
NITRO_APP_PATH The full path to access the iOS package (.app or .ipa)
NITRO_DEPLOY_PATH The full path to access the iOS package (.app or .ipa)

🙋 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: