diff --git a/bitrise.yml b/bitrise.yml index ab06bd7..2456b40 100644 --- a/bitrise.yml +++ b/bitrise.yml @@ -7,7 +7,7 @@ workflows: ci: envs: - SAMPLE_APP_URL: "https://github.com/bitrise-io/sample-apps-flutter-veggieseasons.git" - - BRANCH: fastlane + - BRANCH: master before-run: - audit-this-step steps: diff --git a/step.yml b/step.yml index 5b9d5d3..d1ee0ea 100644 --- a/step.yml +++ b/step.yml @@ -1,13 +1,34 @@ title: "fastlane" summary: |- - Runs your fastlane lane. + Runs your fastlane lane on [bitrise.io](https://www.bitrise.io). description: |- - Runs your fastlane lane. + fastlane is an open-source app automation tool for iOS, Android and for most cross-platform frameworks, for example, React Native, Xamarin and Flutter. + **fastlane** Step helps you integrate your lane to your Bitrise Workflow and runs your lane based on the fastlane actions with minimal configuration. + If your Apple Developer Portal account is connected to Bitrise, the `FASTLANE_SESSION` Environment Variable will pass on the session data to fastlane. + + ### Configuring the Step + 1. Add the **fastlane** Step to your Workflow after the **Git Clone Repository** Step or any other dependency Step. + 1. Based on your project's fastlane setup, you can add your project's default lane or a custom lane in the **fastlane lane** input. + 2. If your fastlane directory is not available in your repository's root, then you can add the parent directory of fastlane directory in the **Working directory** input. + 3. If your project doesn't contain a fastlane gem in your project's Gemfile, you can use the **Should update fastlane gem before run** input. + Set this input to `true` so that the Step can install the latest fastlane version to your project. + If a gem lockfile (Gemfile.lock or gems.locked) includes the fastlane gem in the working directory, that specific fastlane version will be installed. + 4. Select `yes` in the **Enable verbose logging** input if you wish to run your build in debug mode and print out error additional debug logs. + 5. Select `yes` in the **Enable collecting files to be included in the build cache** to cache pods, Carthage and Android dependencies. - If `Gemfile` exists in the `work_dir` directory, fastlane will be used by - calling `bundle install` then `bundle exec`. + ### Troubleshooting + If you run your lane on Bitrise and your build fails on the **fastlane** Step, the logs won't reveal too much about the error since it's most likely related to the fastlane file's configuration. + We recommend you swap your fastlane actions for Bitrise Steps which will bring out the problem. - Otherwise the system installed `fastlane` version will be used. + ### Useful links + - [About fastlane](https://docs.fastlane.tools) + - [Connecting your Apple Developer Account to Bitrise](https://devcenter.bitrise.io/getting-started/connecting-apple-dev-account/) + - [Running fastlane on Bitrise](https://devcenter.bitrise.io/tutorials/fastlane/fastlane-index/) + + ### Related Steps + - [Deploy to iTunes Connect/Deliver](https://www.bitrise.io/integrations/steps/yarn) + - [iOS Auto Provision](https://www.bitrise.io/integrations/steps/bundler) + - [Fastlane Match](https://www.bitrise.io/integrations/steps/fastlane-match) website: https://github.com/bitrise-io/steps-fastlane source_code_url: https://github.com/bitrise-io/steps-fastlane support_url: https://github.com/bitrise-io/steps-fastlane/issues