Add automation and configuration for Prototype Builds

PodcastsIntents/PodcastsIntents.prototype.entitlements

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>com.apple.security.application-groups</key>
+	<array>
+		<string>group.au.com.shiftyjelly.pocketcasts.prototype</string>
+	</array>
+</dict>
+</plist>

Share Extension/Share Extension.prototype.entitlements

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>com.apple.security.application-groups</key>
+	<array>
+		<string>group.au.com.shiftyjelly.pocketcasts.prototype</string>
+	</array>
+</dict>
+</plist>

WidgetExtension/WidgetExtension.prototype.entitlements

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>com.apple.security.application-groups</key>
+	<array>
+		<string>group.au.com.shiftyjelly.pocketcasts.prototype</string>
+	</array>
+</dict>
+</plist>

config/PocketCasts.base.xcconfig

@@ -4,5 +4,10 @@ SWIFT_VERSION = 5.0
 
 // Map our custom version values (used by the automation tooling) to the values
 // Xcode uses
-MARKETING_VERSION=$(VERSION_SHORT)
-CURRENT_PROJECT_VERSION=$(VERSION_LONG)
+MARKETING_VERSION = $(VERSION_SHORT)
+CURRENT_PROJECT_VERSION = $(VERSION_LONG)
+
+// Define a root bundle identifier so that extensions can append to it
+PRODUCT_BUNDLE_IDENTIFIER_ROOT = au.com.shiftyjelly.podcasts
+
+DEVELOPMENT_TEAM = PZYM8XX95Q // Automattic, Inc. (Company)

config/PocketCasts.debug.xcconfig

@@ -1 +1,3 @@
 #include "PocketCasts.base.xcconfig"
+
+PRODUCT_BUNDLE_IDENTIFIER = $PRODUCT_BUNDLE_IDENTIFIER_ROOT

config/PocketCasts.prototype.xcconfig

@@ -0,0 +1,12 @@
+#include "PocketCasts.base.xcconfig"
+
+// Redefining doesn't seem to work, Xcode resolves it as ".prototype" only
+//PRODUCT_BUNDLE_IDENTIFIER_ROOT = $(PRODUCT_BUNDLE_IDENTIFIER_ROOT).prototype
+PRODUCT_BUNDLE_IDENTIFIER_ROOT = au.com.shiftyjelly.podcasts.prototype
+PRODUCT_BUNDLE_IDENTIFIER = $(PRODUCT_BUNDLE_IDENTIFIER_ROOT)
+
+DEVELOPMENT_TEAM = 99KV9Z6BKV // Automattic, Inc. (Enterprise)
+
+// Notice that because currently all extensions use this xcconfig for the Prototype bulid configuration,
+// this line is enough to set the Provisioning Profiles for all.
+PROVISIONING_PROFILE_SPECIFIER = match InHouse $(PRODUCT_BUNDLE_IDENTIFIER)

config/PocketCasts.release.xcconfig

@@ -1 +1,6 @@
 #include "PocketCasts.base.xcconfig"
+
+PRODUCT_BUNDLE_IDENTIFIER = $PRODUCT_BUNDLE_IDENTIFIER_ROOT
+// Notice that because currently all extensions use this xcconfig for the Release bulid configuration,
+// this line is enough to set the Provisioning Profiles for all.
+PROVISIONING_PROFILE_SPECIFIER = match AppStore $(PRODUCT_BUNDLE_IDENTIFIER)

fastlane/Fastfile

@@ -25,6 +25,7 @@ ENV_FILE_NAME = 'pocket-casts-ios.env'
 USER_ENV_FILE_PATH = File.join(Dir.home, '.a8c-apps', ENV_FILE_NAME)
 
 TEAM_ID_APP_STORE = 'PZYM8XX95Q'
+TEAM_ID_ENTERPRISE = '99KV9Z6BKV'
 
 CODE_SIGNING_STORAGE_OPTIONS = {
   storage_mode: 's3',
@@ -36,6 +37,7 @@ GHHELPER_REPO = 'Automattic/pocket-casts-ios'
 DEFAULT_BRANCH = 'trunk'
 
 SCHEME = 'pocketcasts'
+SCHEME_ENTERPRISE = 'Pocket Casts Prototype Build'
 
 # Instanstiate versioning classes
 VERSION_CALCULATOR = Fastlane::Wpmreleasetoolkit::Versioning::SemanticVersionCalculator.new
@@ -44,22 +46,35 @@ BUILD_CODE_FORMATTER = Fastlane::Wpmreleasetoolkit::Versioning::FourPartBuildCod
 VERSION_FILE = Fastlane::Wpmreleasetoolkit::Versioning::IOSVersionFile.new(xcconfig_path: VERSION_XCCONFIG_PATH)
 
 APP_BUNDLE_IDENTIFIER_APP_STORE = 'au.com.shiftyjelly.podcasts'
+APP_BUNDLE_IDENTIFIER_ENTERPRISE = "#{APP_BUNDLE_IDENTIFIER_APP_STORE}.prototype".freeze
 
+# Keep this in alphabetical case-insensitive order so it's easier to visually compare with the list on the Developers Portal.
 EXTENSIONS = %w[
-  NotificationExtension
   NotificationContent
-  watchkitapp
+  NotificationExtension
   PodcastsIntents
   PodcastsIntentsUI
-  WidgetExtension
   Share-Extension
+  watchkitapp
+  WidgetExtension
 ].freeze
 
 BUNDLE_IDENTIFIERS_APP_STORE = [
   APP_BUNDLE_IDENTIFIER_APP_STORE,
   *EXTENSIONS.map { |suffix| "#{APP_BUNDLE_IDENTIFIER_APP_STORE}.#{suffix}" }
 ].freeze
 
+BUNDLE_IDENTIFIERS_ENTERPRISE = [
+  APP_BUNDLE_IDENTIFIER_ENTERPRISE,
+  *EXTENSIONS.map { |suffix| "#{APP_BUNDLE_IDENTIFIER_ENTERPRISE}.#{suffix}" }
+].freeze
+
+ASC_API_KEY_ENV_VARS = %w[
+  APP_STORE_CONNECT_API_KEY_KEY_ID
+  APP_STORE_CONNECT_API_KEY_ISSUER_ID
+  APP_STORE_CONNECT_API_KEY_KEY
+].freeze
+
 FROZEN_STRINGS_PATH = File.join(FASTLANE_FOLDER, 'Frozen.strings')
 
 EN_LPROJ_FOLDER = File.join(PROJECT_ROOT_FOLDER, 'podcasts', 'en.lproj')
@@ -156,11 +171,7 @@ platform :ios do
 
   desc 'Download and configure code signing certificates and provisioning profiles for the App Store build.'
   lane :configure_code_signing_app_store do |options|
-    require_env_vars!(
-      'APP_STORE_CONNECT_API_KEY_KEY_ID',
-      'APP_STORE_CONNECT_API_KEY_ISSUER_ID',
-      'APP_STORE_CONNECT_API_KEY_KEY'
-    )
+    require_env_vars!(*ASC_API_KEY_ENV_VARS)
 
     sync_code_signing(
       type: 'appstore',
@@ -174,6 +185,39 @@ platform :ios do
     )
   end
 
+  desc 'Download and configure code signing certificates and provisioning profiles for the Enterprise build, i.e. Prototype Builds.'
+  lane :configure_code_signing_enterprise do |options|
+    require_env_vars!(*ASC_API_KEY_ENV_VARS)
+
+    readonly = options.fetch(:readonly, true)
+
+    if readonly
+      # In readonly mode, we can use the API key.
+      #
+      # Notice the `in_house: true` parameter.
+      # Unfortunately, even using it, the API does not allow modifying certs or profiles via API key.
+      # It's here for reference and future-proofing.
+      api_key = app_store_connect_api_key(in_house: true)
+    else
+      # The Enterprise account APIs do not support authentication via API key.
+      # If we want to modify data (readonly = false) we need to authenticate manually.
+      prompt_user_for_app_store_connect_credentials
+      # We also need to pass no API key, otherwise Fastlane will give precedence to that authentication mode.
+      api_key = nil
+    end
+
+    sync_code_signing(
+      type: 'enterprise',
+      team_id: TEAM_ID_ENTERPRISE,
+      api_key: api_key,
+      app_identifier: BUNDLE_IDENTIFIERS_ENTERPRISE,
+      # This might turn out to be useful in the future
+      # template_name: 'CarPlay audio app (CarPlay + Media Player frameworks)iOS (Dist)'
+      readonly: options.fetch(:readonly, true),
+      **CODE_SIGNING_STORAGE_OPTIONS
+    )
+  end
+
   #####################################################################################
   # Release Lanes
   #####################################################################################
@@ -550,6 +594,22 @@ platform :ios do
     trigger_beta_build(branch_to_build: release_branch_name)
   end
 
+  desc 'Builds for Enterprise distribution (Prototype Build)'
+  lane :build_enterprise do
+    configure_code_signing_enterprise
+
+    build_app(
+      scheme: SCHEME_ENTERPRISE,
+      include_bitcode: false,
+      include_symbols: true,
+      clean: true,
+      export_options: {
+        method: 'enterprise',
+        manageAppVersionAndBuildNumber: false
+      }
+    )
+  end
+
   # Sets the stage to start working on a hotfix
   #
   # - Cuts a new `release/x.y.z` branch from the tag from the latest (`x.y`) version

fastlane/lib/helpers.rb

@@ -33,3 +33,12 @@ def get_required_env!(key, env_file_path: USER_ENV_FILE_PATH)
 
   ENV.fetch(key)
 end
+
+def prompt_user_for_app_store_connect_credentials
+  require 'credentials_manager'
+
+  # If Fastlane cannot instantiate a user, it will ask the caller for the email.
+  # Once we have it, we can set it as `FASTLANE_USER` in the environment (which has lifecycle limited to this call) so that the next commands will already have access to it.
+  # Note: if the user is already available to `AccountManager`, setting it in the env is redundant, but Fastlane doesn't provide a way to check it so we have to do it anyway.
+  ENV['FASTLANE_USER'] = CredentialsManager::AccountManager.new.user
+end