ENG-5771: Add firebase app distribution support #2769

seanirby · 2024-10-30T22:11:40Z

Describe your changes

This PR updates the Fastlane plugin to optionally support a configuration for firebase app distribution. If the config is provided the plugin will add the necessary lanes. Besides including this configuration, the only other step for projects to integrate with FAD is to update their Github actions/workflows and to create a secret in their repo, GOOGLE_SERVICE_CREDENTIALS, which contains the firebase credentials for the google service account.

Overview of changes:

Update Fastfile templates to provide conditional firebase lanes.
Update Pluginfile templates to conditionally provide the necessary appcenter and/or firebase gems.
Fastlane Pluginfiles templates are now rendered to account for conditional gem installations
Updated tests

~~NOTE: I still need to verify Firebase Android release builds. I'm getting a failure on those builds because the app isn't linked to a Google Play account.~~

Firebase release uploads have been verified to be working with this plugin logic using the theory app.

https://console.firebase.google.com/project/theory-57e35/appdistribution/app/android:com.fastretailing.theory/releases

Issue ticket number and link

https://brandingbrand.atlassian.net/browse/ENG-5771

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

Test Plan

I created an example shopify template using the flagship accelerator. I used the config provided below and updated my repo to include the google service credential secret for the shopify project. I've given Nick Burkhart view permissions to the project so he can check it out. Currently the firebase builds are working for both platforms except the release Android builds aren't uploading because there isn't a Google Play account linked to the Firebase Shopify app.

  codePluginFastlane: {
    plugin: {
      ios: {
        appCenter: {
          organization: 'Branding-Brand',
          appName: 'Shopify-iOS-Internal',
          destinationType: 'group',
          destinations: ['IAT'],
        },
        firebase: {
          groups: ['IAT'],
          appId: '1:300374277703:ios:cdf8a81375502895bcbb62',
        },
      },
      android: {
        appCenter: {
          organization: 'Branding-Brand',
          appName:
            'Shopify-Android-Internal',
          destinationType: 'group',
          destinations: ['IAT'],
        },
        firebase: {
          groups: ['IAT'],
          appId: '1:300374277703:android:764c235c8f6d7dc6bcbb62',
        },
      },
    },
  },

Checklist before requesting a review

A self-review of my code has been completed
Tests have been added / updated if required
Documentation has been updated to reflect these changes

NickBurkhartBB · 2024-11-05T17:49:25Z

Note: as currently setup in PR this is a breaking change as it changes the lanes you use to upload.

packages/plugin-fastlane/src/index.ts

packages/plugin-fastlane/template/android/fastlane/Fastfile

seanirby · 2024-11-05T21:31:36Z

I've addressed PR comments and also updated the lanes so this update should be nonbreaking. I did a quick test on theory repo with the existing workflows: https://github.com/brandingbrand/theory/actions/runs/11692375987

NickBurkhartBB

@seanirby It looks good, just a nitpick about the outputted Fastfile, the whitespace is a little messed up due to extra indents in the template due to indenting based off EJS if statements.

NickBurkhartBB · 2024-11-06T17:08:25Z

packages/plugin-fastlane/template/android/fastlane/Fastfile

@@ -31,6 +31,37 @@ lane :increment_build do
 end
 <% } -%>

+lane :increment_build_appcenter do
+  <% if(codePluginFastlane.plugin && codePluginFastlane.plugin.android && codePluginFastlane.plugin.android.appCenter) { -%>
+    increment_build


nitpick: whitespace of output is off, remember the if statement is EJS and not part of the output so don't need to indent things below it or you get double indentation

NickBurkhartBB · 2024-11-06T17:10:54Z

packages/plugin-fastlane/template/ios/fastlane/Fastfile

@@ -76,6 +76,15 @@ lane :increment_build do
 end
 <% } -%>

+lane :increment_build_appcenter do
+  <% if(codePluginFastlane.plugin && codePluginFastlane.plugin.ios && codePluginFastlane.plugin.ios.appCenter) { -%>
+    increment_build


whitespace of outputted Fastfile, no indent after EJS

NickBurkhartBB · 2024-11-06T17:11:19Z

packages/plugin-fastlane/template/ios/fastlane/Fastfile

+
+lane :increment_build_firebase do
+  <% if(codePluginFastlane.plugin && codePluginFastlane.plugin.ios && codePluginFastlane.plugin.ios.firebase) { -%>
+    begin


whitespace in output, no indent after EJS if

NickBurkhartBB · 2024-11-06T17:11:41Z

packages/plugin-fastlane/template/ios/fastlane/Fastfile

+  build
+
+  <% if(codePluginFastlane.plugin && codePluginFastlane.plugin.ios && codePluginFastlane.plugin.ios.appCenter) { -%>
+    appcenter_upload(


whitespace of output, no indent after EJS if

seanirby · 2024-11-06T18:22:32Z

@seanirby It looks good, just a nitpick about the outputted Fastfile, the whitespace is a little messed up due to extra indents in the template due to indenting based off EJS if statements.

I'll fix this up.

packages/plugin-fastlane/template/android/fastlane/Fastfile

seanirby force-pushed the ENG-5771 branch from 083eef4 to c6bd95f Compare October 30, 2024 22:13

seanirby added 2 commits October 30, 2024 15:15

ENG-5771: Add firebase app distribution support

d475395

ENG-5771: Update templates so only one build will be made in CI/CD

84167ea

seanirby force-pushed the ENG-5771 branch from c6bd95f to 84167ea Compare November 1, 2024 15:29

seanirby marked this pull request as ready for review November 4, 2024 18:52

NickBurkhartBB reviewed Nov 5, 2024

View reviewed changes

packages/plugin-fastlane/src/index.ts Outdated Show resolved Hide resolved

packages/plugin-fastlane/template/android/fastlane/Fastfile Outdated Show resolved Hide resolved

ENG-5771: Keep existing lanes so update is non-breaking

049bd09

ENG-5771: Update tests, fix whitespace/newline discrepancies

507babb

NickBurkhartBB requested changes Nov 6, 2024

View reviewed changes

ENG-5771: Fix indents after EJS conditionals

cc3406a

NickBurkhartBB reviewed Nov 6, 2024

View reviewed changes

packages/plugin-fastlane/template/android/fastlane/Fastfile Outdated Show resolved Hide resolved

ENG-5771: Fix indents before EJS conditionals

cfcba63

NickBurkhartBB approved these changes Nov 6, 2024

View reviewed changes

NickBurkhartBB merged commit f26b470 into brandingbrand:develop Nov 6, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ENG-5771: Add firebase app distribution support #2769

ENG-5771: Add firebase app distribution support #2769

seanirby commented Oct 30, 2024 •

edited by NickBurkhartBB

Loading

NickBurkhartBB commented Nov 5, 2024

seanirby commented Nov 5, 2024

NickBurkhartBB left a comment

NickBurkhartBB Nov 6, 2024

NickBurkhartBB Nov 6, 2024

NickBurkhartBB Nov 6, 2024

NickBurkhartBB Nov 6, 2024

seanirby commented Nov 6, 2024

ENG-5771: Add firebase app distribution support #2769

ENG-5771: Add firebase app distribution support #2769

Conversation

seanirby commented Oct 30, 2024 • edited by NickBurkhartBB Loading

Describe your changes

Issue ticket number and link

Type of change

Test Plan

Checklist before requesting a review

NickBurkhartBB commented Nov 5, 2024

seanirby commented Nov 5, 2024

NickBurkhartBB left a comment

Choose a reason for hiding this comment

NickBurkhartBB Nov 6, 2024

Choose a reason for hiding this comment

NickBurkhartBB Nov 6, 2024

Choose a reason for hiding this comment

NickBurkhartBB Nov 6, 2024

Choose a reason for hiding this comment

NickBurkhartBB Nov 6, 2024

Choose a reason for hiding this comment

seanirby commented Nov 6, 2024

seanirby commented Oct 30, 2024 •

edited by NickBurkhartBB

Loading