README
¶
Flutter Build
Builds a Flutter project.
Description
This Step builds an iOS and an Android app. By default the Step builds the artifact based on the platform the scanner detects.
Configuring the Step
- In the Project Location input the root directory of your Flutter project is automatically filled out.
- Select which platform your project should be built for (
ios,androidorboth). - Enable Debug option to get verbose logs and see where the Step is failing.
Depending on the selected platform/s, continue with the rest of the config inputs.
Configuring for an iOS app
- Make sure the Platform input is set to
iOSorboth. - In Codesign Identity you can onverride the code signing identities that you set in Flutter.
- In Additional parameters add any flag to customize your build (for example, the
--releaseflag appended toflutter build iobuilds a deployable iOS app). - Leave the Output pattern input's default value as is or modify it to the pattern if your build artifacts are stored elsewhere.
- Make sure you have the Xcode Archive & Export for iOS Step after the Flutter Build Step in your Workflow.
Configuring for an Android app
- Insert the Android Sign Step after the Flutter Build Step and make sure code signing files are uploaded to the Code Signing tab.
- Make sure the Platform input is set to
Androidorboth. - Scroll down to the
Android Platform Configsinput section, and select the preferred output artifact type you wish to generate in the Android output artifact type input. The Step can build an APK and an Android App Bundle as well. - Append any flag to the
buildcommand in the Additional parameters input. - Leave the Output pattern input's default value as is or modify it to the pattern if your build artifacts are stored elsewhere.
Troubleshooting
Make sure the Flutter Install Step is before the Flutter Build Step. If you have not set up code signing correctly, some code signing related issue will definitely surface by this build Step. If you're unsure about code signing, consult our guide linked in Useful links.
Useful links
Related Steps
🧩 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 |
|---|---|---|---|
project_location |
The root dir of your Flutter project. | required | $BITRISE_SOURCE_DIR |
platform |
The selected platform will be built, or both iOs and Android if you select both | required | both |
additional_build_params |
Additional params for flutter build. Example: you can specify a Build Number for flutter build via the --build-number flutter build param. For example, to set it to the $BITRISE_BUILD_NUMBER you can set this input to: --build-number=$BITRISE_BUILD_NUMBER. |
||
is_debug_mode |
If debug mode is enabled, the step will print verbose logs | required | false |
cache_level |
If enabled, will cache: - pub packages - Android (gradle) cache - Carthage / Cocoapods dependencies | required | all |
ios_output_type |
Output type to build when building for iOS. Possible values: - app: Build an iOS application bundle via flutter build ios - archive: Build an iOS archive bundle via flutter build ipa |
required | app |
ios_codesign_identity |
Override codesign identity in .flutter_settings | ||
ios_additional_params |
The flags from this input field will be appended to the flutter build ios command. |
--release |
|
ios_output_pattern |
Separate patterns with a newline. | required | *build/ios/iphoneos/*.app *build/ios/archive/*.xcarchive |
android_output_type |
The selected output type will be build, either APK or app bundle (AAB) | required | apk |
android_additional_params |
The flags from this input field will be appended to the flutter build apk command. |
--release |
|
android_output_pattern |
Will find the APK or AAB files - depending on the build type input - with the given pattern.Separate patterns with a newline. Note The step will export only the selected artifact type - Android output artifact type - even if the filter would accept other artifact types as well. |
required | *build/app/outputs/apk/*/*.apk *build/app/outputs/bundle/*/*.aab |
android_bundle_output_pattern |
Pattern to find built AAB artifacts relative to $BITRISE_SOURCE_DIR |
*build/app/outputs/bundle/*/*.aab |
Outputs
| Environment Variable | Description |
|---|---|
BITRISE_APK_PATH |
The created .apk file's path. |
BITRISE_APK_PATH_LIST |
All created .apk file paths, separated by |. |
BITRISE_APP_DIR_PATH |
The generated .app directory's path. |
BITRISE_XCARCHIVE_PATH |
The generated .xcarchive directory's path. |
BITRISE_XCARCHIVE_ZIP_PATH |
The generated .xcarchive directory compressed as a ZIP archive. |
BITRISE_AAB_PATH_LIST |
This output will include the paths of the generated AAB files, after filtering based on the filter inputs. The paths are separated with | character, eg: app.aab|app2.aab |
BITRISE_AAB_PATH |
This output will include the path of the generated AAB file, after filtering based on the filter inputs. If the build generates more than one AAB file which fulfills the filter inputs this output will contain the last one's path. |
🙋 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:
Documentation
¶
There is no documentation for this package.
Source Files
Click to show internal directories.
Click to hide internal directories.