AppChef builds app installers including APK and IPA from a Cordova zip that can be exported from the WaveMaker Studio. Thus, generated APK or IPA, can be used for testing or can be uploaded to the Play Store and App Store for distribution.
Prerequisite to build using AppChef
To perform a Build using AppChef, you should have the application Cordova zip. WaveMaker provides an option to export your mobile application to a Cordova zip. For more information, see download cordova zip.
Using the Workspace Toolbar from Build task select Open AppChef. It will navigate you to the AppChef application.
To login, click Login with WaveMaker
If there are no builds, a dialog will be shown to choose between Read documentation or Create new build.
Steps to build using AppChef
Build through AppChef is a three-step process, as described below.
- Upload Cordova zip
- Configure AppInfo
- Configure Build
Upload Cordova zip
Click on create new build option, drag and drop or browse your files to upload cordova zip.
After Successful upload, AppInfo will be pre-populated from your uploaded cordova zip. You have options to modify them to your choice.
Click Next to configure the Build options.
In this step, you can provide a distribution profile and choose certificates of the profile respectively.
|Cordova||This is the cordova version that is required by the uploaded app. This cannot be modified.|
|Build Type||There are two options, 1) Development and 2) Production. Choose ‘Development’ to create a debuggable app -- typically for testing. Choose ‘Production’ to create an apk or ipa to distribute on play store or app store.|
|Cordova IOS||This is the cordova-ios version that is required by the uploaded app. This cannot be modified.|
|IOS Certificate||In this option, either you have to choose already uploaded certificates or you can upload a new one. Choose the right certificate that supports ‘Build Type’ selected.|
|Cordova Android||This is the cordova-android version that is required by the uploaded app. This cannot be modified|
|Android Certificate||In this option, A default _DEBUG certificate is available to generate an android application. _DEBUG certificate can only support ‘Development’ build type. You can either choose already uploaded certificates or you can upload a new one. Choose the right certificate that supports ‘Build Type’ selected.|
|Android Package||This option will be visible only if Android certificate is selected. This dropdown has only two options (aab and apk). If the build type is development, then Android package is set as apk. If the build type is production, then Android package is set as aab. Users can override the default behaviour with their choice.|
Provide the required options and click Save and Build to start building the application.
Uploaded certificates password will be cleared after every 24 hours, you need to provide password whenever prompted. To know more, click here
Manage or Upload Certificates
During the build process, i.e., in the last step of the build, there is an Add icon to upload certificates for Android and iOS . Dialog will be shown specific to store android and iOS certificates.
These are the options that are shown when you want to add an IOS certificate
These are the options that are shown when you want to add an Android certificate
You always have an option to check the uploaded certificates where you can add a new one, lock or unlock the certificate and delete the existing ones by opening the options from the application menu which is located at the right top corner.
To secure the uploaded certificates, passwords will be saved in encrypted format. A Certificate with password is in unlocked state and builds can only be triggered with unlocked certificates. Certificates will get automatically locked after 24 hours of unlocking, To unlock the certificate you have to provide password again.
A dialog will be shown to unlock certificate in two cases,
In configure build step, while uploading cordova zip
For iOS, you need to enter certificate password
For android, you need to enter Key password and Store password
While re-queuing the build in an existing application.
Checking status of the submitted build request
Once you click on save and build for an application, the build will be available in MyApps section. Open the application card and check the build info and status related to it. You can also delete the application card if it is not required.
Only a maximum of 25 applications can be built using AppChef. You can delete the applications that are not necessary.
These are the details that are shown for the submitted application.
Application build stages
Application build status has following stages
- Queued - Server is waiting for the worker to pick up the job.
- Processing - Once a worker picks the job, status will be changed to processing.
- Success - If build is successful from the server, status will be changed to success.
- Failed - If build is failed from the server, status will be changed to failed.
- Timed-out - If build time is more, status will be changed to timed-out and it is a failed job.
- Cancelled - If build is cancelled using cancel option, status will be changed to cancelled.
Application Build Actions
Every build has five actions. i.e.,
- Download the build log - Build log is available for a failed and as well as for a successful job.
- Download artifact - It has APK/IPA file, this option is available only for successful jobs
- Queue the build - You can rebuild the application. this option is available for a successful or a failed job
- Cancel build - Cancel build will cancel the job which is in progress, this option is available only for the job whose Queued or Processing.
- Delete build - Delete the build, this option is available in all the stages of the build.
Manage the existing application
To perform builds for the latest cordova zip of the existing application, you have an option to upload cordova zip and build info of the application will be shown in the application itself.
Only the last 10 builds are shown under the Builds section. If build requests exceeds 10, a message will be shown to delete the existing builds.
After the successful build, you can install the application in Android or iOS devices by scanning the QRcode which is located at the right corner as shown below.
or, you can click on the platform (IOS, Android) under the build info to scan a particular build QRCode.