Added optional release notes (#73)

Author: Josh Holtz

fastlane/Fastfile

@@ -23,7 +23,8 @@ lane :ipa21 do
     region: 'us-west-1',
     ipa: './fastlane/ipa21/BanditTheCat.ipa',
     source: './fastlane/ipa21/source',
-    skip_html_upload: false
+    skip_html_upload: false,
+    release_notes: 'Hey some notes <br/>And some other notes<br/>And some other'
   )
 end
 
@@ -42,7 +43,8 @@ lane :apk1 do
     region: 'us-west-1',
     apk: './fastlane/apk1/BanditTheCat.apk',
     source: './fastlane/apk1/source',
-    skip_html_upload: false
+    skip_html_upload: false,
+    release_notes: 'Hey some notes <br/>And some other notes<br/>And some other'
   )
 end
 

lib/assets/s3_android_html_template.erb

@@ -11,6 +11,12 @@
         text-align: center;
         background-color: #f5f5f5;
       }
+      h1 {
+        margin-bottom: 0px;
+      }
+      h2 {
+        margin-top: 5px;
+      }
       .oneRow {
         width: 100%;
         overflow: auto;
@@ -50,15 +56,19 @@
     </style>
 
     <h1 style="text-align: center;"><%= title %></h1>
+    <h2><%= version_name %> (<%= version_code %>)</h2>
+    <p><em>Built on <%= Time.now.strftime('%a, %e %b %Y %H:%M %p') %></em></p>
     <!-- <img src="app_icon.png" id="appIcon"> -->
 
     <div class="oneRow">
       <span class="download" id="android">
         <a href="<%= apk_url %>" id="text" class="btn btn-lg btn-default" onclick="document.getElementById('finished').id = '';">
           Install <%= title %> <%= version_name %> (<%= version_code %>)
         </a>
-        <br>
-        <p>Built on <%= Time.now.strftime('%a, %e %b %Y %H:%M %p') %></p>
+      </span>
+
+      <span class="info">
+        <p><%= release_notes %></p>
       </span>
 
       <!-- <span class="download" id="android">

lib/assets/s3_android_version_template.erb

@@ -1,4 +1,7 @@
 {
     "latestVersion": "<%= full_version %>",
-    "updateUrl": "<%= apk_url %>"
+    "updateUrl": "<%= apk_url %>",
+    "version_code": "<%= version_code %>",
+    "version_name": "<%= version_name %>",
+    "release_notes": "<%= release_notes %>"
 }

lib/assets/s3_ios_html_template.erb

@@ -11,6 +11,12 @@
         text-align: center;
         background-color: #f5f5f5;
       }
+      h1 {
+        margin-bottom: 0px;
+      }
+      h2 {
+        margin-top: 5px;
+      }
       .oneRow {
         width: 100%;
         overflow: auto;
@@ -50,15 +56,20 @@
     </style>
 
     <h1 style="text-align: center;"><%= title %></h1>
+    <h2><%= bundle_version %> (<%= build_num %>)</h2>
+    <p><em>Built on <%= Time.now.strftime('%a, %e %b %Y %H:%M %p') %></em></p>
     <!-- <img src="app_icon.png" id="appIcon"> -->
 
     <div class="oneRow">
+
       <span class="download" id="ios">
         <a href="itms-services://?action=download-manifest&url=<%= url_encode(plist_url) %>" id="text" class="btn btn-lg btn-default" onclick="document.getElementById('finished').id = '';">
           Install <%= title %> <%= bundle_version %> (<%= build_num %>)
         </a>
-        <br>
-        <p>Built on <%= Time.now.strftime('%a, %e %b %Y %H:%M %p') %></p>
+      </span>
+
+      <span class="info">
+        <p><%= release_notes %></p>
       </span>
 
       <!-- <span class="download" id="android">

lib/assets/s3_ios_version_template.erb

@@ -1,4 +1,9 @@
 {
     "latestVersion": "<%= full_version %>",
-    "updateUrl": "itms-services://?action=download-manifest&url=<%= url_encode(plist_url) %>"
+    "updateUrl": "itms-services://?action=download-manifest&url=<%= url_encode(plist_url) %>",
+    "plist_url": "<%= plist_url %>",
+    "ipa_url": "<%= ipa_url %>",
+    "build_number": "<%= build_num %>",
+    "bundle_version": "<%= bundle_version %>",
+    "release_notes": "<%= release_notes %>"
 }

lib/fastlane/plugin/aws_s3/actions/aws_s3_action.rb

@@ -29,6 +29,7 @@ def self.run(config)
         params[:ipa] = config[:ipa]
         params[:xcarchive] = config[:xcarchive]
         params[:dsym] = config[:dsym]
+        params[:release_notes] = config[:release_notes]
         params[:access_key] = config[:access_key]
         params[:secret_access_key] = config[:secret_access_key]
         params[:aws_profile] = config[:aws_profile]
@@ -64,6 +65,7 @@ def self.run(config)
         s3_endpoint = params[:endpoint]
         apk_file = params[:apk]
         ipa_file = params[:ipa]
+        release_notes = params[:release_notes]
         xcarchive_file = params[:xcarchive]
         files = params[:files]
         folder = params[:folder]
@@ -101,16 +103,16 @@ def self.run(config)
           xcarchive_file = Actions.lane_context[SharedValues::XCODEBUILD_ARCHIVE]
         end
 
-        upload_ipa(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, ipa_file, dsym_file, s3_path, acl, server_side_encryption) if ipa_file.to_s.length > 0
-        upload_apk(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, apk_file, s3_path, acl, server_side_encryption) if apk_file.to_s.length > 0
+        upload_ipa(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, ipa_file, dsym_file, release_notes, s3_path, acl, server_side_encryption) if ipa_file.to_s.length > 0
+        upload_apk(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, apk_file, release_notes, s3_path, acl, server_side_encryption) if apk_file.to_s.length > 0
         upload_xcarchive(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, ipa_file, xcarchive_file, s3_path, acl, server_side_encryption) if xcarchive_file.to_s.length > 0
         upload_files(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, files, s3_path, acl, server_side_encryption) if files.to_a.count > 0
         upload_folder(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, folder, s3_path, acl, server_side_encryption) if folder.to_s.length > 0
 
         return true
       end
 
-      def self.upload_ipa(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, ipa_file, dsym_file, s3_path, acl, server_side_encryption)
+      def self.upload_ipa(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, ipa_file, dsym_file, release_notes, s3_path, acl, server_side_encryption)
 
         s3_path = "v{CFBundleShortVersionString}_b{CFBundleVersion}/" unless s3_path
 
@@ -220,7 +222,8 @@ def self.upload_ipa(s3_client, params, s3_region, s3_access_key, s3_secret_acces
           build_num: build_num,
           bundle_id: bundle_id,
           bundle_version: bundle_version,
-          title: title
+          title: title,
+          release_notes: release_notes
         }.merge(html_template_params))
 
         # Creates version from template
@@ -235,7 +238,8 @@ def self.upload_ipa(s3_client, params, s3_region, s3_access_key, s3_secret_acces
           ipa_url: ipa_url,
           build_num: build_num,
           bundle_version: bundle_version,
-          full_version: full_version
+          full_version: full_version,
+          release_notes: release_notes
         }.merge(version_template_params))
 
         #####################################
@@ -288,7 +292,7 @@ def self.upload_xcarchive(s3_client, params, s3_region, s3_access_key, s3_secret
         UI.success("Successfully uploaded archive file to '#{Actions.lane_context[SharedValues::S3_XCARCHIVE_OUTPUT_PATH]}'")
       end
 
-      def self.upload_apk(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, apk_file, s3_path, acl, server_side_encryption)
+      def self.upload_apk(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, apk_file, release_notes, s3_path, acl, server_side_encryption)
         version = get_apk_version(apk_file)
 
         version_code = version[0]
@@ -347,7 +351,8 @@ def self.upload_apk(s3_client, params, s3_region, s3_access_key, s3_secret_acces
           apk_url: apk_url,
           version_code: version_code,
           version_name: version_name,
-          title: title
+          title: title,
+          release_notes: release_notes
         }.merge(html_template_params))
 
         # Creates version from template
@@ -360,7 +365,8 @@ def self.upload_apk(s3_client, params, s3_region, s3_access_key, s3_secret_acces
           apk_url: apk_url,
           version_code: version_code,
           version_name: version_name,
-          full_version: "#{version_code}_#{version_name}"
+          full_version: "#{version_code}_#{version_name}",
+          release_notes: release_notes
         }.merge(version_template_params))
 
         #####################################
@@ -571,6 +577,10 @@ def self.available_options
                                        description: "zipped .dsym package for the build ",
                                        optional: true,
                                        default_value: Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH]),
+          FastlaneCore::ConfigItem.new(key: :release_notes,
+                                       env_name: "",
+                                       description: "release notes to display on the html page and version json",
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :upload_metadata,
                                        env_name: "",
                                        description: "Upload relevant metadata for this build",

lib/fastlane/plugin/aws_s3/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module AwsS3
-    VERSION = "1.5.0"
+    VERSION = "1.6.0"
   end
 end