-
Notifications
You must be signed in to change notification settings - Fork 10
Add docs for Testing and publish on Google Play Store #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| { | ||
| "label": "Publish", | ||
| "position": 2 | ||
| } |
345 changes: 345 additions & 0 deletions
345
docs/test-and-publish/publish/google-playstore-deployment.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,345 @@ | ||
| --- | ||
| slug: /deployment/google-playstore-deployment | ||
| title: Google Play Store Deployment | ||
| description: Learn how to deploy your apps to the Google Play Store using Dreamflow. | ||
| tags: [Google Play Store, Deployment, Dreamflow, Android] | ||
| sidebar_position: 3 | ||
| toc_max_heading_level: 4 | ||
| keywords: [Google Play Store, Deployment, Dreamflow, Android] | ||
| --- | ||
|
|
||
| # Google Play Store Deployment | ||
|
|
||
| Dreamflow allows you to deploy your apps directly to the Google Play Store from within the platform. This guide covers all the necessary prerequisites, a step-by-step deployment process, and common troubleshooting tips. | ||
|
|
||
| :::info[Prerequisites] | ||
|
|
||
| - Register for a [**Google Play Developer account**](https://play.google.com/console/signup). | ||
| - Ensure you have set an app launcher icon. If not, add an app icon to the Dreamflow assets, then use the [**flutter_launcher_icons**](https://pub.dev/packages/flutter_launcher_icons) package or ask the AI agent to set it up for you. | ||
| - Ensure your app package name is correct, as it cannot be changed after deployment. To verify it, open `android/app/build.gradle` and check the `applicationId`. To update the package name, you can use the [**change_app_package_name**](https://pub.dev/packages/change_app_package_name) package or simply ask the AI agent. | ||
| - It's recommended to [**test your app on a real device**](../test/test-on-mobile-device.md) before deployment. | ||
|
|
||
| ::: | ||
|
|
||
| ## 1. Creating app on Google Play Store | ||
|
|
||
| To create a new app in the Google Play Store, start by opening the [Google Play Console](https://play.google.com/console) and clicking the **Create app** button. Enter the **App name**, select the app type, and choose whether the app will be **Free** or **Paid**. After that, accept the **Declarations**, and finally click **Create app** to proceed. | ||
|
|
||
| <div style={{ | ||
| position: 'relative', | ||
| paddingBottom: 'calc(50.67989417989418% + 41px)', // Keeps the aspect ratio and additional padding | ||
| height: 0, | ||
| width: '100%'}}> | ||
| <iframe | ||
| src="https://demo.arcade.software/364L2UfaOKcHiJH5GIAv?embed&show_copy_link=true" | ||
| title="" | ||
| style={{ | ||
| position: 'absolute', | ||
| top: 0, | ||
| left: 0, | ||
| width: '100%', | ||
| height: '100%', | ||
| colorScheme: 'light' | ||
| }} | ||
| frameborder="0" | ||
| loading="lazy" | ||
| webkitAllowFullScreen | ||
| mozAllowFullScreen | ||
| allowFullScreen | ||
| allow="clipboard-write"> | ||
| </iframe> | ||
| </div> | ||
| <p></p> | ||
|
|
||
| ## 2. Set up your app | ||
|
|
||
| To provide the app details required by the Google Play Store, go to the **Set up your app** section within your newly created app. Expand the **View tasks** list, then click on each task and complete the required information step by step. | ||
|
|
||
|  | ||
|
|
||
| ## 3. Adding service account credentials | ||
|
|
||
| To enable Dreamflow to deploy your app to the Google Play Store, you need to add service account credentials. | ||
|
|
||
| ### 3.1 Creating a Service Account | ||
|
|
||
| To create the Service Account, you can follow the instructions from [here](https://developers.google.com/android-publisher/getting_started). To help you get started quickly, here are the exact steps you need to follow: | ||
|
|
||
| 1. If you haven't set up Firebase in your app, you'll need to [create a Google Cloud Project](https://developers.google.com/android-publisher/getting_started#creating). | ||
| 2. Then, head over to the [Google Play Developer API page](https://console.developers.google.com/apis/api/androidpublisher.googleapis.com/) in Google Cloud Console and click **Enable**. | ||
|
|
||
|  | ||
|
|
||
| 3. In Google Cloud Console, go to [Service Accounts](https://console.cloud.google.com/iam-admin/serviceaccounts), click + **CREATE SERVICE ACCOUNT,** and follow the steps as shown below. | ||
|
|
||
| <div style={{ | ||
| position: 'relative', | ||
| paddingBottom: 'calc(50.67989417989418% + 41px)', // Keeps the aspect ratio and additional padding | ||
| height: 0, | ||
| width: '100%'}}> | ||
| <iframe | ||
| src="https://demo.arcade.software/v4qg6mfKvbKGKISqJZg8?embed&show_copy_link=true" | ||
| title="" | ||
| style={{ | ||
| position: 'absolute', | ||
| top: 0, | ||
| left: 0, | ||
| width: '100%', | ||
| height: '100%', | ||
| colorScheme: 'light' | ||
| }} | ||
| frameborder="0" | ||
| loading="lazy" | ||
| webkitAllowFullScreen | ||
| mozAllowFullScreen | ||
| allowFullScreen | ||
| allow="clipboard-write"> | ||
| </iframe> | ||
| </div> | ||
| <p></p> | ||
|
|
||
|
|
||
| 4. Now, download the JSON key file by clicking **ADD Key > Create new key > select JSON > CREATE**. Keep this file secure. | ||
|
|
||
| <div style={{ | ||
| position: 'relative', | ||
| paddingBottom: 'calc(50.67989417989418% + 41px)', // Keeps the aspect ratio and additional padding | ||
| height: 0, | ||
| width: '100%'}}> | ||
| <iframe | ||
| src="https://demo.arcade.software/ZMZFspS0ZI3xIc0bSago?embed&show_copy_link=true" | ||
| title="" | ||
| style={{ | ||
| position: 'absolute', | ||
| top: 0, | ||
| left: 0, | ||
| width: '100%', | ||
| height: '100%', | ||
| colorScheme: 'light' | ||
| }} | ||
| frameborder="0" | ||
| loading="lazy" | ||
| webkitAllowFullScreen | ||
| mozAllowFullScreen | ||
| allowFullScreen | ||
| allow="clipboard-write"> | ||
| </iframe> | ||
| </div> | ||
| <p></p> | ||
|
|
||
| 5. In **Google Play Console**, go to [Users & Permissions](https://play.google.com/console), click **Invite new users**, and add your service account email with these permissions: | ||
| - "Edit and delete draft apps" | ||
| - "Release to production..." | ||
| - "Release apps to testing tracks" | ||
| - "Manage testing tracks and edit tester lists" | ||
|
|
||
| <div style={{ | ||
| position: 'relative', | ||
| paddingBottom: 'calc(50.67989417989418% + 41px)', // Keeps the aspect ratio and additional padding | ||
| height: 0, | ||
| width: '100%'}}> | ||
| <iframe | ||
| src="https://demo.arcade.software/PLVogskcfVTMqJk4nfig?embed&show_copy_link=true" | ||
| title="" | ||
| style={{ | ||
| position: 'absolute', | ||
| top: 0, | ||
| left: 0, | ||
| width: '100%', | ||
| height: '100%', | ||
| colorScheme: 'light' | ||
| }} | ||
| frameborder="0" | ||
| loading="lazy" | ||
| webkitAllowFullScreen | ||
| mozAllowFullScreen | ||
| allowFullScreen | ||
| allow="clipboard-write"> | ||
| </iframe> | ||
| </div> | ||
| <p></p> | ||
|
|
||
| ### 3.2 Uploading service account credentials to Dreamflow | ||
|
|
||
| To upload your service account credentials in Dreamflow, go to **Publish > Android**. Under **Google Play Credentials**, click **Upload .json** and select the `.json` file you downloaded in step 4. | ||
|
|
||
|  | ||
|
|
||
| ## 4. Deploy to Google Play Store | ||
|
|
||
| For first-time deployment, you need to create an initial release manually in Google Play Console. After that, Dreamflow can handle all subsequent deployments. | ||
|
|
||
| ### 4.1 First-time setup | ||
|
|
||
| 1. In Dreamflow, set the **Google Play Track** to **Internal**. | ||
| 2. Specify the **Bundle ID** and **Version Code** and then click **Submit Build to Google Play**. | ||
| 3. Once the build is complete, download the [**.aab**](https://chatgpt.com/share/6f5714c1-eb13-428b-b9ee-9772f2810284) file. | ||
| 4. In Google Play Console, create an **Internal Testing** track and upload the **.aab** file. | ||
|
|
||
| :::info | ||
|
|
||
| - After the internal testing track is set up, Dreamflow can handle all future deployments directly. | ||
| - Even if the build status appears as FAILURE, you can still download the AAB file. | ||
|
|
||
| ::: | ||
|
|
||
|
|
||
| <div style={{ | ||
| position: 'relative', | ||
| paddingBottom: 'calc(50.67989417989418% + 41px)', // Keeps the aspect ratio and additional padding | ||
| height: 0, | ||
| width: '100%'}}> | ||
| <iframe | ||
| src="https://demo.arcade.software/pBlnRQnHLQRjSFWJTtHw?embed&show_copy_link=true" | ||
| title="" | ||
| style={{ | ||
| position: 'absolute', | ||
| top: 0, | ||
| left: 0, | ||
| width: '100%', | ||
| height: '100%', | ||
| colorScheme: 'light' | ||
| }} | ||
| frameborder="0" | ||
| loading="lazy" | ||
| webkitAllowFullScreen | ||
| mozAllowFullScreen | ||
| allowFullScreen | ||
| allow="clipboard-write"> | ||
| </iframe> | ||
| </div> | ||
| <p></p> | ||
|
|
||
| ### 4.2 Deploy from Dreamflow | ||
|
|
||
| To deploy your app from Dreamflow, navigate to **Publish > Android**, set the **Track** to Internal, and update the **version code.** If your app is still in draft mode (not yet available on the Play Store), set **Submit as Draft** (under **Deployment Flags)** to **True**, and then click **Deploy to Play Store**. | ||
|
|
||
| <div style={{ | ||
| position: 'relative', | ||
| paddingBottom: 'calc(50.67989417989418% + 41px)', // Keeps the aspect ratio and additional padding | ||
| height: 0, | ||
| width: '100%'}}> | ||
| <iframe | ||
| src="https://demo.arcade.software/lryE56z4DG52mIeJLwhn?embed&show_copy_link=true" | ||
| title="" | ||
| style={{ | ||
| position: 'absolute', | ||
| top: 0, | ||
| left: 0, | ||
| width: '100%', | ||
| height: '100%', | ||
| colorScheme: 'light' | ||
| }} | ||
| frameborder="0" | ||
| loading="lazy" | ||
| webkitAllowFullScreen | ||
| mozAllowFullScreen | ||
| allowFullScreen | ||
| allow="clipboard-write"> | ||
| </iframe> | ||
| </div> | ||
| <p></p> | ||
|
|
||
| :::info | ||
|
|
||
| - If another deployment is already in progress, deploying a new build will cancel the previous one. | ||
| - It may take a few minutes for the request to process. Once completed, you will get a pop-up saying *Your app is being deployed to Google Play.* | ||
|
|
||
| ::: | ||
|
|
||
| ### 4.3 Verify deployment | ||
|
|
||
| To verify that the app is deployed to Play Console: | ||
|
|
||
| 1. Open the **Internal testing** in [Google Play Console](https://play.google.com/console). | ||
| 2. Under the **Releases** section, find your release and click on the **Show Summary** button. | ||
| 3. See the **Version Codes** number is increased. | ||
|
|
||
|  | ||
|
|
||
| ### 4.4 Deploy to production | ||
|
|
||
| To promote your app to production, open your **Internal testing** track in Google Play Console and complete the release. Once the internal release is finalized, click **Promote Release > Production**. | ||
|
|
||
| <div style={{ | ||
| position: 'relative', | ||
| paddingBottom: 'calc(50.67989417989418% + 41px)', // Keeps the aspect ratio and additional padding | ||
| height: 0, | ||
| width: '100%'}}> | ||
| <iframe | ||
| src="https://demo.arcade.software/8TQoQjPZEetKsEptLJ2w?embed&show_copy_link=true" | ||
| title="" | ||
| style={{ | ||
| position: 'absolute', | ||
| top: 0, | ||
| left: 0, | ||
| width: '100%', | ||
| height: '100%', | ||
| colorScheme: 'light' | ||
| }} | ||
| frameborder="0" | ||
| loading="lazy" | ||
| webkitAllowFullScreen | ||
| mozAllowFullScreen | ||
| allowFullScreen | ||
| allow="clipboard-write"> | ||
| </iframe> | ||
| </div> | ||
| <p></p> | ||
|
|
||
| For all future deployments, set the **Google Play Track** to **Prod** in Dreamflow and deploy directly from there. | ||
|
|
||
|  | ||
|
|
||
| ## Deployment Flags | ||
|
|
||
| ### Submit as draft | ||
|
|
||
| While deploying, if your app is still in draft mode, meaning it is not available on the Play Store yet, you may encounter an error message stating, 'Only releases with the status draft may be created on a draft app.' | ||
|
|
||
| To resolve this, enable this option, and you'll see that the release will be created as a draft. You'll then need to manually roll out the app. | ||
|
|
||
| ### Changes not sent for review | ||
|
|
||
| If you face an error that says '*Changes cannot be sent for review automatically*', enable this option and retry deployment. | ||
|
|
||
| ## FAQs | ||
|
|
||
| <details> | ||
| <summary> | ||
| Why am I getting an "Invalid Package Name" error? | ||
| </summary> | ||
| <p> | ||
| This happens when your package name already exists or doesn’t meet validation requirements. Make sure your package name is unique and not already used by another app on Google Play Store. Note that the package name cannot be changed after deployment. | ||
| </p> | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary> | ||
| What should I do if I see "The service account does not have permission to perform this action"? | ||
| </summary> | ||
| <p> | ||
| This means your service account doesn’t have the correct permissions. In Google Play Console, ensure the account has these permissions: | ||
|
|
||
| - *Edit and delete draft apps* | ||
| - *Release to production...* | ||
| - *Release apps to testing tracks* | ||
| - *Manage testing tracks and edit tester lists* | ||
| </p> | ||
| </details> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <details> | ||
| <summary> | ||
| Why does my first upload fail with a message like "You need to use a different package name"? | ||
|
|
||
| </summary> | ||
| <p> | ||
| For the initial deployment, you must manually upload the **.aab** file to Google Play Console to create the first release track. Once the initial track is set up, Dreamflow will handle all subsequent deployments automatically. | ||
|
||
| </p> | ||
| </details> | ||
|
|
||
|
|
||
Binary file added
BIN
+57.8 KB
docs/test-and-publish/publish/imgs/deploy-to-prod-from-dreamflow.avif
Binary file not shown.
Binary file not shown.
Binary file added
BIN
+148 KB
docs/test-and-publish/publish/imgs/setup-android-app-in-play-console.avif
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| --- | ||
| slug: /publish/pre-checks-before-publishing | ||
| title: Pre-checks Before Publishing | ||
| description: Ensure your app is ready for launch with this detailed guide on essential pre-publishing checks. | ||
| tags: [Pre-checks, Publishing, Deployment] | ||
| sidebar_position: 1 | ||
| keywords: [Pre-checks, Publishing, Deployment, Dreamflow] | ||
| --- | ||
|
|
||
| # Pre-checks Before Publishing | ||
| Before publishing your app, it’s important to run through a checklist to ensure quality, compliance, and readiness for release. These pre-checks help confirm that your app works as expected, meets platform requirements, and provides a smooth user experience. | ||
|
|
||
| Here’s a comprehensive list of these prechecks: | ||
|
|
||
| 1. **Functionality Testing**: [Test the app manually](../test/test-on-mobile-device.md) across devices to verify that every feature behaves correctly, user interactions respond as intended, and no crashes or unexpected errors occur. | ||
| 2. **Get Feedback**: Gather feedback from users or testers to receive valuable insights and potential areas of improvement before the public release. | ||
| 3. **Optimizations & Enhancements**: Review your app’s overall performance and make sure all assets are optimized. This includes, but is not limited to: | ||
| - Making sure images are properly sized and compressed to reduce load times. | ||
| - Minimizing large files, unused assets, or unnecessary dependencies. | ||
| - Checking that animations and transitions run smoothly without lag. | ||
| - Enable caching strategies where appropriate. | ||
| 4. **User Interface (UI)**: Review UI consistency across different devices, screen sizes, and resolutions. | ||
| 5. **Accessibility Checks**: Use Flutter’s [`Semantics`](https://api.flutter.dev/flutter/widgets/Semantics-class.html) widget on images and buttons to provide meaningful descriptions for assistive technologies. Verify that TalkBack (Android) and VoiceOver (iOS) correctly interpret UI elements. Check color contrast with Flutter’s theming system and ensure that navigation using gestures or keyboard input remains accessible across all screens. | ||
| 6. **Security Measures**: Safeguard user data by using HTTPS for all network requests, encrypting sensitive information, and following best practices for authentication and storage. Ensure compliance with legal standards like GDPR or CCPA, if applicable. | ||
| 7. **Compliance with Store Guidelines**: Carefully review submission policies for both [Apple’s App Store](https://developer.apple.com/app-store/review/guidelines/) and [Google Play Store](https://play.google/developer-content-policy/). Pay attention to metadata, privacy policies, restricted content rules, and minimum functionality requirements. | ||
| 8. **Localization and Internationalization**: If your app targets users in multiple countries, consider [adding multi-language](https://docs.flutter.dev/ui/accessibility-and-internationalization/internationalization) support. | ||
| 9. **License and Third-Party Attributions**: Adhere to licenses and include necessary attributions for third-party libraries and assets. | ||
| 10. **Prepare Marketing Assets**: Prepare all the necessary marketing assets, such as screenshots, app icons, and promotional text. | ||
| 11. **Error Logging & Monitoring**: Integrate crash reporting and analytics (e.g., Firebase Crashlytics, Sentry) before release. Try triggering test crashes in debug or staging builds to confirm reports are collected correctly. | ||
| 12. **Offline & Poor Network Support**: Validate app behavior with no connectivity and high-latency/packet-loss scenarios. Provide cached content, retry/backoff for API calls, and clear offline states. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| { | ||
| "label": "Test", | ||
| "position": 1 | ||
| } |
Binary file not shown.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this should be a separate point / subheading like "Downloading AAB file"
its an important step and also a fallback if the build is not uploaded from dreamflow.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree! updated accordingly.