1 of 4

Build Deploy & Publish

Build & Deploy Flutter Web Application

Overview

This page runs you through the steps to build the web application and deploy in respective environment.

Steps

Follow the instructions here to set up the job pipeline. Ignore the steps not applicable to the front end.

Instructions here are provided assuming CD/CI has been set up using the DIGIT ci-as-code module.

Before setting up the job pipeline, make sure each project has a docker folder in the root folder of the project. The cirrusci flutter docker tag must be mentioned for building the application through Jenkins. Check the image below for reference.

The global assets inside the .env file should be loaded from the environment assets.

Note: The global assets file needs to be in JSON format for Flutter

Follow the sample config added in yaml files of the respective environment to load the global assets of works_shg_app.

dev yaml file : works-dev.yaml

works-shg-app:
  custom-js-injection: |
    sub_filter.conf: "
      sub_filter  '<head>' '<head>
      <script src=https://works-dev.digit.org/works-dev-asset/worksGlobalConfig.json type=text/javascript></script>';"

Congrats!!! We are now ready to build and deploy the application on the web.

Build

Go to the Jenkins build page. Click on your project to build under the folder path mentioned below.

For reference, if works_shg_app need to be build, Go to path digit-works/job/frontend/job/works-shg-app/

Click on Build with parameter. Select the feature branch name by searching for it in the search box on the right side of the screen. Click on Build.

Once the build is successful, open the console output and find the docker image that has been built. Copy the docker image ID.

Deploy

Go to the Jenkins deployments page. Click on the desired environment you want to deploy the build

For reference, Let's deploy the works-shg-app build that was created to works-dev env.

Path ref: https://builds.digit.org/job/deployments/job/deploy-to-works-dev/

Copy the docker image IDs from the previous step and paste in the above box. Click on "Build". Once the image is deployed, you will see a message as shown below:

Generate Android APKs & App Bundles

Steps to generate APKs and App bundles for Android applications

Overview

Follow the steps on this page to build the APK and IPA for deploying in Play Store and App-store.

Steps

Generate APK For Testing

Follow the Flutter Installation and setup Guide and Run the Application till the Flutter pub is set up.
Run the below command in your terminal from theroot of the project to generate the APK
flutter build apk --release

Generate & Publish App Bundle To Play Store

Pre-requisites

Prior knowledge of generating unique key store files for your application ( Reference links: Generating key store for your Android application)
Changing the App name
Changing App Logo (Ref Link: Changing app logo in Flutter)
Prior knowledge of app bundle creation for publishing in the Play Store
Terms and Conditions and Privacy Documents for your application

Note: The generated key store file needs to be added to the Android/app folder of your project. This is needed for publishing the next version of your application.

Steps

Add a key.properties file inside your Android folder which is a reference to your key store file. Below is the sample key.properties file.

storePassword=muktasoft
keyPassword=muktasoft
keyAlias=upload
storeFile=muktasoft.jks

Run the below command in your terminal from the root of the project to generate the App bundle to publish in the play store.

flutter build app bundle

Publishing App Bundle To Play Store

Pre -requirements for publishing the app bundle to play store

Overview

This page provides the requirements that should be met to publish the app bundle to Google Play Store.

Pre-requirements

Before publishing an app bundle to the Google Play Store, ensure that the following requirements are met:

App Content and Policies:
1. Ensure the app complies with Google Play Store policies, including content guidelines, restricted content, and advertising policies.
2. Ensure the app's content does not infringe on intellectual property rights or violate any legal restrictions.
Privacy and Data Handling:
1. Implement appropriate privacy measures to protect user data and comply with privacy regulations (e.g., GDPR).
2. Communicate your app's data handling practices and obtain user consent when necessary.
3. Have Terms & Conditions and Privacy documents handy
Write an engaging and informative app description that accurately represents your app's functionality and benefits.
Choose relevant and compelling promotional graphics, including an app icon and feature graphic.
Store Policies and Agreements:
1. Review and accept the Google Play Developer Distribution Agreement.
2. Familiarize yourself with the Google Play Store policies and ensure your app complies with them.
Developer Account: Create a Google Play Developer account and complete the registration process
Distribution:
1. Choose the appropriate pricing and distribution options for your app, such as free, paid, or freemium models.
2. Select the countries or regions where you want to make your app available.
Release Management:
1. Consider using the Google Play Console's release management tools to monitor and control your app's releases.

Remember to carefully review the Google Play Store's guidelines, documentation, and recommendations for publishing apps to ensure a smooth and successful deployment process.

Publishing App Bundle To Play Store

Pre -requirements for publishing the app bundle to play store

Overview

This page provides the requirements that should be met to publish the app bundle to Google Play Store.

Pre-requirements

Before publishing an app bundle to the Google Play Store, ensure that the following requirements are met:

App Content and Policies:
1. Ensure the app complies with Google Play Store policies, including content guidelines, restricted content, and advertising policies.
2. Ensure the app's content does not infringe on intellectual property rights or violate any legal restrictions.
Privacy and Data Handling:
1. Implement appropriate privacy measures to protect user data and comply with privacy regulations (e.g., GDPR).
2. Communicate your app's data handling practices and obtain user consent when necessary.
3. Have Terms & Conditions and Privacy documents handy
Write an engaging and informative app description that accurately represents your app's functionality and benefits.
Choose relevant and compelling promotional graphics, including an app icon and feature graphic.
Store Policies and Agreements:
1. Review and accept the Google Play Developer Distribution Agreement.
2. Familiarize yourself with the Google Play Store policies and ensure your app complies with them.
Developer Account: Create a Google Play Developer account and complete the registration process
Distribution:
1. Choose the appropriate pricing and distribution options for your app, such as free, paid, or freemium models.
2. Select the countries or regions where you want to make your app available.
Release Management:
1. Consider using the Google Play Console's release management tools to monitor and control your app's releases.

Remember to carefully review the Google Play Store's guidelines, documentation, and recommendations for publishing apps to ensure a smooth and successful deployment process.

Build & Deploy Flutter Web Application

Overview

This page runs you through the steps to build the web application and deploy in respective environment.

Steps

Follow the instructions here to set up the job pipeline. Ignore the steps not applicable to the front end.

Instructions here are provided assuming CD/CI has been set up using the DIGIT ci-as-code module.

The global assets inside the .env file should be loaded from the environment assets.

Note: The global assets file needs to be in JSON format for Flutter

Follow the sample config added in yaml files of the respective environment to load the global assets of works_shg_app.

dev yaml file : works-dev.yaml

works-shg-app:
  custom-js-injection: |
    sub_filter.conf: "
      sub_filter  '<head>' '<head>
      <script src=https://works-dev.digit.org/works-dev-asset/worksGlobalConfig.json type=text/javascript></script>';"

Congrats!!! We are now ready to build and deploy the application on the web.

Build

Go to the Jenkins build page. Click on your project to build under the folder path mentioned below.

For reference, if works_shg_app need to be build, Go to path digit-works/job/frontend/job/works-shg-app/

Click on Build with parameter. Select the feature branch name by searching for it in the search box on the right side of the screen. Click on Build.

Once the build is successful, open the console output and find the docker image that has been built. Copy the docker image ID.

Deploy

Go to the Jenkins deployments page. Click on the desired environment you want to deploy the build

For reference, Let's deploy the works-shg-app build that was created to works-dev env.

Path ref: https://builds.digit.org/job/deployments/job/deploy-to-works-dev/

Copy the docker image IDs from the previous step and paste in the above box. Click on "Build". Once the image is deployed, you will see a message as shown below:

Generate Android APKs & App Bundles

Steps to generate APKs and App bundles for Android applications

Overview

Follow the steps on this page to build the APK and IPA for deploying in Play Store and App-store.

Steps

Generate APK For Testing

Follow the Flutter Installation and setup Guide and Run the Application till the Flutter pub is set up.
Run the below command in your terminal from theroot of the project to generate the APK
flutter build apk --release

Generate & Publish App Bundle To Play Store

Pre-requisites

Prior knowledge of generating unique key store files for your application ( Reference links: Generating key store for your Android application)
Changing the App name
Changing App Logo (Ref Link: Changing app logo in Flutter)
Prior knowledge of app bundle creation for publishing in the Play Store
Terms and Conditions and Privacy Documents for your application

Note: The generated key store file needs to be added to the Android/app folder of your project. This is needed for publishing the next version of your application.

Steps

Add a key.properties file inside your Android folder which is a reference to your key store file. Below is the sample key.properties file.

storePassword=muktasoft
keyPassword=muktasoft
keyAlias=upload
storeFile=muktasoft.jks

Run the below command in your terminal from the root of the project to generate the App bundle to publish in the play store.

flutter build app bundle