ci: distribute demo app as beta version (#12) (#50)

The aim of this commit is to allow to build and upload a beta version of the application thanks to a nightly build using our internal GitLab CI pipelines.

This commit:
- updates the documentation ;
- improves logs in Fastlane lanes for clearer CI logs ;
- adds verbatim in TestFlight changelog to say wether or not the build is a beta or an alpha build

Closes #12

Signed-off-by: Pierre-Yves Lapersonne <[email protected]>

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- [Showcase] Distribute demo app development version ([#12](https://github.com/Orange-OpenSource/ouds-ios/issues/12)) 
 - [Showcase] Distribute demo app for feature validation ([#13](https://github.com/Orange-OpenSource/ouds-ios/issues/13))
 - [Library] Define Swift Package library for OUDS ([#46](https://github.com/Orange-OpenSource/ouds-ios/issues/46))
 - [Showcase] Create the basic architecture of the demo application ([#6](https://github.com/Orange-OpenSource/ouds-ios/issues/6))

Showcase/Showcase.xcodeproj/project.pbxproj

@@ -548,7 +548,7 @@
 				ASSETCATALOG_COMPILER_GLOBAL_ACCENT_COLOR_NAME = AccentColor;
 				ASSETCATALOG_COMPILER_INCLUDE_ALL_APPICON_ASSETS = YES;
 				CODE_SIGN_STYLE = Automatic;
-				CURRENT_PROJECT_VERSION = 00;
+				CURRENT_PROJECT_VERSION = 2;
 				DEVELOPMENT_ASSET_PATHS = "\"Showcase/Preview Content\"";
 				DEVELOPMENT_TEAM = MG2LSJNJB6;
 				ENABLE_PREVIEWS = YES;
@@ -586,7 +586,7 @@
 				ASSETCATALOG_COMPILER_INCLUDE_ALL_APPICON_ASSETS = YES;
 				"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Distribution";
 				CODE_SIGN_STYLE = Manual;
-				CURRENT_PROJECT_VERSION = 00;
+				CURRENT_PROJECT_VERSION = 2;
 				DEVELOPMENT_ASSET_PATHS = "\"Showcase/Preview Content\"";
 				DEVELOPMENT_TEAM = "";
 				"DEVELOPMENT_TEAM[sdk=iphoneos*]" = MG2LSJNJB6;

Showcase/fastlane/Fastfile

@@ -211,7 +211,7 @@ platform :ios do
         build
         if params[:upload]
             puts "Upload to TestFlight requested"
-            upload
+            upload(type: "prod")
         else
             puts "Upload to TestFlight not requested"
         end
@@ -227,7 +227,7 @@ platform :ios do
             puts "👉 Build and upload (alpha)"
             update_build_number
             build
-            upload 
+            upload(type: "alpha")
 
         else # Beta case (not production too), detailSymbol should be here commit hash
             detailSymbol = params[:detailSymbol]
@@ -241,21 +241,21 @@ platform :ios do
                 update_build_number
                 build
             else
-                puts "Nothing new to build today, a CI tag for commit '#{detailSymbol}' already exists"
+                puts "ℹ️ Nothing new to build today, a CI tag for commit '#{detailSymbol}' already exists"
                 publish_mattermost_notification("⚙️ 🤔 Nothing new to build today, a CI tag for commit '#{detailSymbol}' already exists")
             end
 
             if params[:upload]
-                puts "Upload to TestFlight requested"
+                puts "ℹ️ Upload to TestFlight requested"
                 # If already uploaded, prevents to upload again
                 if tag_testflight_upload(detailSymbol)
-                    upload 
+                    upload(type: "beta")
                 else
-                    puts "Nothing new to build today, a TestFlight tag for commit '#{detailSymbol}' already exists"
+                    puts "ℹ️ Nothing new to build today, a TestFlight tag for commit '#{detailSymbol}' already exists"
                     publish_mattermost_notification("⚙️ 🤔 Nothing new to build today, a TestFlight tag for commit '#{detailSymbol}' already exists")
                 end
             else
-                puts "Upload to TestFlight not requested"
+                puts "ℹ️ Upload to TestFlight not requested"
             end
 
         end
@@ -302,7 +302,6 @@ platform :ios do
             # Needed for upload later as .xcarchive for App Store through corporate portal
             zip(path: "build/oudsApp.xcarchive",
                 output_path: "build/oudsApp.zip")
-
 
             version = get_app_version
             build_number = get_build_number(xcodeproj: OUDS_PROJECT)
@@ -318,7 +317,7 @@ platform :ios do
     # PRIVATE LANE UPLOAD TO TESTFLIGHT (ALPHA / BETA / PROD is set by main lane)
     # ---------------------------------------------------------------------------
     desc "PRIVATE LANE UPLOAD TO TESTFLIGHT"
-    private_lane :upload do
+    private_lane :upload do |params|
         puts "👉 Upload"
 
         begin
@@ -338,7 +337,14 @@ platform :ios do
             build_number = get_build_number(xcodeproj: OUDS_PROJECT)
             puts "ℹ️ App build number: '#{build_number}'"
 
-            news = read_current_release_notes
+            uploadType = params[:type]
+            if uploadType != nil && uploadType.to_s.empty? == false
+                puts "ℹ️ Upload type: '#{uploadType}'"
+                news = "Warning: this is #{uploadType} build\n\n" + read_current_release_notes # Add details about build type in changelog for TestFlight
+            else
+                puts "ℹ️ Upload type seems to be production"
+                news = read_current_release_notes
+            end
 
             upload_to_testflight(
                 changelog: news,
@@ -368,7 +374,7 @@ platform :ios do
 
         begin
             if commitHash.nil? || commitHash.empty?
-                puts "No parameter sent for CI tag, nothing will be done"
+                puts "ℹ️ No parameter sent for CI tag, nothing will be done"
                 publish_mattermost_notification("⚙️ 🤔 No commit hash has been given, no tag can be created")
                 return false
             else
@@ -392,7 +398,7 @@ platform :ios do
 
         begin     
             if commitHash.nil? || commitHash.empty?
-                puts "No parameter sent for CI tag, nothing will be done"
+                puts "ℹ️ No parameter sent for CI tag, nothing will be done"
                 publish_mattermost_notification("⚙️ 🤔 No commit hash has been given, no tag can be created")
                 return false
             else
@@ -416,19 +422,19 @@ platform :ios do
 
         # Check personal access token for tag creation
         if GITHUB_ACCESS_TOKEN.nil? || GITHUB_ACCESS_TOKEN.empty?
-            puts "Error: No GitHub access token defined, cannot create and push tags"
+            puts "❌ Error: No GitHub access token defined, cannot create and push tags"
             publish_mattermost_notification("⚙️ 😰 @channel No GitHub access token defined, cannot create and push tags!")
             return false
         else
             # Check if given tag exists yet
-            puts "Check if '#{tag}' exists yet"
+            puts "ℹ️ Check if '#{tag}' exists yet"
             result=sh("curl -s 'https://api.github.com/repos/Orange-OpenSource/ouds-ios/git/refs/tags/#{tag}' | jq -r '.ref'") # TODO Shell error management
             # If tag exists, CURL response is formatted like "refs/tags/tag"
             if "refs/tags/#{tag}".eql? result.strip # Removes line break available in command result
-                puts "The tag '#{tag}' still exists, won't create new tag"
+                puts "ℹ️ The tag '#{tag}' still exists, won't create new tag"
                 return false
             else
-                puts "Commit SHA to tag is '#{IOS_APP_COMMIT_SHA}'"
+                puts "ℹ️ Commit SHA to tag is '#{IOS_APP_COMMIT_SHA}'"
                 # Just a light tag is enough 
                 sh("curl -L \
                   -X POST \
@@ -465,19 +471,19 @@ platform :ios do
     def read_current_release_notes
         version = get_app_version
 
-        changelog=read_changelog(
+        changelog = read_changelog(
             changelog_path: '../CHANGELOG.md',
             section_identifier: "[#{version}]",
         )
 
         if changelog == ""
-            changelog=read_changelog(
+            changelog = read_changelog(
                 changelog_path: '../CHANGELOG.md',
                 section_identifier: "[Unreleased]",
             )
         end
 
-        puts "Current relase notes = #{changelog}"
+        puts "ℹ️ Current relase notes = #{changelog}"
         return changelog
     end
 end

docs_release/README.md

@@ -12,7 +12,8 @@ This file lists all the steps to follow when releasing a new version of OUDS iOS
   * [GitHub download Shell script](#github-download-shell-script)
 - [How it works](#how-it-works)
   * [Alpha builds](#alpha-builds)
-
+  * [Beta builds](#beta-builds)
+
 ## Prepare release
 
 - Create a branch named `prepare-release` to prepare the new release for OUDS iOS version X.Y.Z.
@@ -571,3 +572,13 @@ The *alpha* build then will be uploaded <a href="./images/build-alpha-TestFlight
 Both our <a href="./images/build-alpha-Mattermost-details.png">_Mattermost_ hook</a> and the _Fastlane_ lanes produce details about the build like <a href="./images/build-alpha-GitLabCI-meta_details.png">version, issues</a> and <a href="./images/build-alpha-GitLabCI-build_number.png">build number</a>.
 
 There are also in the app <a href="./images/build-alpha-in_app.jpeg">some extra fields</a> defined in the app _Info.plist_ through _Fastlane_ and _GitLab CI_ showing the app version, its build number, the build type (DEBUG for local builds, ALPHA for alpha release, BETA for beta release, PROD for production release) and the build details (issues numbers). The <a href="./images/build-alpha-display_name.jpeg">display name</a> will be modified too.
+
+### Beta builds
+
+The *beta* builds are created with a scheduled pipeline.
+This is quite the same logic as *alpha builds*, but with Git tags associated to the builds on *develop* branch (one for the build prefixed by *ci/*, one for TestFlight upload prefixed by *Test_Flight*) with commit hash as suffix.
+
+The *beta* build is automatically uploaded to _TestFlight_ for a dedicated team (here *beta-team*).
+
+The *Mattermsot* hook is also used, the app display name and the build details are updated too.
+