Skip to main content

File Size Check

The File Size Check component checks the size of your generated IPA, APK or AAB file. It compares it against the size you have given and if the size is exceeded, it either fails the build or writes a warning to the build log.

Prerequisites​

The workflow steps that need to be executed before running the File Size Check workflow step, along with their respective reasons, are listed in the table below.

Prerequisite Workflow StepDescription
Xcodebuild for DevicesIf your project is an iOS project using Objective-C/Swift or React Native, you should use this step to generate the file before checking the app file size. This step generates the IPA file.
Flutter Build for iOSIf your project is an iOS project using Flutter, you should use this step to generate the file before checking the app file size. This step generates an IPA file.
Android BuildIf your project is an Android project using Java/Kotlin or React Native, you should use this step to generate the file before checking the app file size. This step generates APK or AAB files.
Flutter Build for AndroidIf your project is an Android project using Flutter, you should use this step to generate the file before checking the app file size. This step generates APK or AAB files.
danger

If you use a different build step than the ones mentioned above to generate the app, then the File Size Check step depends on this particular step.

For iOS​

Screenshot

For Android​

Screenshot

Input Variables​

This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s).

note

When you enter this component detail, you need to specify the File Size and Check Action. The file size parameter here represents the maximum allowable size of the IPA, APK or AAB file. If the archived application size exceeds this size, the step fails and stops the build when the check action is fail, or writes a warning line to the build log when it is warn.

Screenshot

With warn, the build status does not change, so check the build log for the size warning. To keep the build running but mark it in your build list, select fail and turn on Continue with the next step even if this step fails for this step. The build then appears as Warning in your build list:

Build list showing a build with the Warning status
Variable NameDescriptionStatus
$AC_ANALYZER_SOURCE_PATHFull path of the APK, AAB or IPA file. Don't change it to use default artifacts. This path will be generated after the build steps.Required
$AC_ANALYZER_FILESIZE_THRESHOLDFile size threshold of the artifacts in megabytes. Enter 0 to disable the check. The default variable is 200MB.Required
$AC_ANALYZER_FILESIZE_ACTIONSpecifies whether to write a warning to the build log or fail the step if the threshold limit is exceeded. The options are warn and fail, with the default being warn.Optional
caution

Note that this step only controls the size of the application generated according to the size variable you specify.


To access the source code of this component, please use the following link:

Preview of GitHub - appcircleio/appcircle-filesize-component