Merge pull request #29 from michael-patzer/MMC-2039_synchronize_versions

Created `set_version` lane to synchronize versions in the SDK and upd…

Author: michael-patzer

Changelog.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.5] - 2020-04-14
+### Added
+- `set_version` lane to Fastfile
+
+### Changed
+- `release` lane no longer accepts a `version` argument
+
 ## [0.1.4] - 2020-03-19
 ### Fixed
 - podspec validation

Gemfile.lock

@@ -75,6 +75,7 @@ GEM
       xcodeproj (>= 1.13.0, < 2.0.0)
       xcpretty (~> 0.3.0)
       xcpretty-travis-formatter (>= 0.0.3)
+    fastlane-plugin-versioning (0.4.3)
     gh_inspector (1.1.3)
     google-api-client (0.36.4)
       addressable (~> 2.5, >= 2.5.1)
@@ -168,6 +169,7 @@ PLATFORMS
 
 DEPENDENCIES
   fastlane (= 2.143.0)
+  fastlane-plugin-versioning
 
 BUNDLED WITH
    2.1.4

MailchimpSDK.podspec

@@ -8,7 +8,7 @@
 
 Pod::Spec.new do |s|
   s.name             = 'MailchimpSDK'
-  s.version          = '0.1.4'
+  s.version          = '0.1.5'
   s.summary          = 'Mailchimp SDK for iOS'
 
   s.description      = <<-DESC

MailchimpSDK/Gemfile.lock

@@ -0,0 +1,179 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    CFPropertyList (3.0.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    atomos (0.1.3)
+    aws-eventstream (1.0.3)
+    aws-partitions (1.289.0)
+    aws-sdk-core (3.92.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.239.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-kms (1.30.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-s3 (1.61.1)
+      aws-sdk-core (~> 3, >= 3.83.0)
+      aws-sdk-kms (~> 1)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.1.1)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+    babosa (1.0.3)
+    claide (1.0.3)
+    colored (1.2)
+    colored2 (3.1.2)
+    commander-fastlane (4.4.6)
+      highline (~> 1.7.2)
+    declarative (0.0.10)
+    declarative-option (0.1.0)
+    digest-crc (0.5.1)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.7.5)
+    emoji_regex (1.0.1)
+    excon (0.73.0)
+    faraday (0.17.3)
+      multipart-post (>= 1.2, < 3)
+    faraday-cookie_jar (0.0.6)
+      faraday (>= 0.7.4)
+      http-cookie (~> 1.0.0)
+    faraday_middleware (0.13.1)
+      faraday (>= 0.7.4, < 1.0)
+    fastimage (2.1.7)
+    fastlane (2.144.0)
+      CFPropertyList (>= 2.3, < 4.0.0)
+      addressable (>= 2.3, < 3.0.0)
+      aws-sdk-s3 (~> 1.0)
+      babosa (>= 1.0.2, < 2.0.0)
+      bundler (>= 1.12.0, < 3.0.0)
+      colored
+      commander-fastlane (>= 4.4.6, < 5.0.0)
+      dotenv (>= 2.1.1, < 3.0.0)
+      emoji_regex (>= 0.1, < 2.0)
+      excon (>= 0.71.0, < 1.0.0)
+      faraday (~> 0.17)
+      faraday-cookie_jar (~> 0.0.6)
+      faraday_middleware (~> 0.13.1)
+      fastimage (>= 2.1.0, < 3.0.0)
+      gh_inspector (>= 1.1.2, < 2.0.0)
+      google-api-client (>= 0.29.2, < 0.37.0)
+      google-cloud-storage (>= 1.15.0, < 2.0.0)
+      highline (>= 1.7.2, < 2.0.0)
+      json (< 3.0.0)
+      jwt (~> 2.1.0)
+      mini_magick (>= 4.9.4, < 5.0.0)
+      multi_xml (~> 0.5)
+      multipart-post (~> 2.0.0)
+      plist (>= 3.1.0, < 4.0.0)
+      public_suffix (~> 2.0.0)
+      rubyzip (>= 1.3.0, < 2.0.0)
+      security (= 0.1.3)
+      simctl (~> 1.6.3)
+      slack-notifier (>= 2.0.0, < 3.0.0)
+      terminal-notifier (>= 2.0.0, < 3.0.0)
+      terminal-table (>= 1.4.5, < 2.0.0)
+      tty-screen (>= 0.6.3, < 1.0.0)
+      tty-spinner (>= 0.8.0, < 1.0.0)
+      word_wrap (~> 1.0.0)
+      xcodeproj (>= 1.13.0, < 2.0.0)
+      xcpretty (~> 0.3.0)
+      xcpretty-travis-formatter (>= 0.0.3)
+    gh_inspector (1.1.3)
+    google-api-client (0.36.4)
+      addressable (~> 2.5, >= 2.5.1)
+      googleauth (~> 0.9)
+      httpclient (>= 2.8.1, < 3.0)
+      mini_mime (~> 1.0)
+      representable (~> 3.0)
+      retriable (>= 2.0, < 4.0)
+      signet (~> 0.12)
+    google-cloud-core (1.5.0)
+      google-cloud-env (~> 1.0)
+      google-cloud-errors (~> 1.0)
+    google-cloud-env (1.3.1)
+      faraday (>= 0.17.3, < 2.0)
+    google-cloud-errors (1.0.0)
+    google-cloud-storage (1.25.1)
+      addressable (~> 2.5)
+      digest-crc (~> 0.4)
+      google-api-client (~> 0.33)
+      google-cloud-core (~> 1.2)
+      googleauth (~> 0.9)
+      mini_mime (~> 1.0)
+    googleauth (0.11.0)
+      faraday (>= 0.17.3, < 2.0)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (~> 0.12)
+    highline (1.7.10)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    httpclient (2.8.3)
+    jmespath (1.4.0)
+    json (2.3.0)
+    jwt (2.1.0)
+    memoist (0.16.2)
+    mini_magick (4.10.1)
+    mini_mime (1.0.2)
+    multi_json (1.14.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    nanaimo (0.2.6)
+    naturally (2.2.0)
+    os (1.0.1)
+    plist (3.5.0)
+    public_suffix (2.0.5)
+    representable (3.0.4)
+      declarative (< 0.1.0)
+      declarative-option (< 0.2.0)
+      uber (< 0.2.0)
+    retriable (3.1.2)
+    rouge (2.0.7)
+    rubyzip (1.3.0)
+    security (0.1.3)
+    signet (0.13.2)
+      addressable (~> 2.3)
+      faraday (>= 0.17.3, < 2.0)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    simctl (1.6.8)
+      CFPropertyList
+      naturally
+    slack-notifier (2.3.2)
+    terminal-notifier (2.0.0)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    tty-cursor (0.7.1)
+    tty-screen (0.7.1)
+    tty-spinner (0.9.3)
+      tty-cursor (~> 0.7)
+    uber (0.1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+    unicode-display_width (1.7.0)
+    word_wrap (1.0.0)
+    xcodeproj (1.15.0)
+      CFPropertyList (>= 2.3.3, < 4.0)
+      atomos (~> 0.1.3)
+      claide (>= 1.0.2, < 2.0)
+      colored2 (~> 3.1)
+      nanaimo (~> 0.2.6)
+    xcpretty (0.3.0)
+      rouge (~> 2.0.7)
+    xcpretty-travis-formatter (1.0.0)
+      xcpretty (~> 0.2, >= 0.0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fastlane
+
+BUNDLED WITH
+   2.1.4

MailchimpSDK/MailchimpSDK.xcodeproj/project.pbxproj

@@ -511,7 +511,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 0.1.4;
+				MARKETING_VERSION = 0.1.5;
 				PRODUCT_BUNDLE_IDENTIFIER = com.theRocketScienceGroup.MailchimpSDK;
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
 				SKIP_INSTALL = YES;
@@ -540,7 +540,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 0.1.4;
+				MARKETING_VERSION = 0.1.5;
 				PRODUCT_BUNDLE_IDENTIFIER = com.theRocketScienceGroup.MailchimpSDK;
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
 				SKIP_INSTALL = YES;
@@ -560,6 +560,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
+				MARKETING_VERSION = 0.1.5;
 				PRODUCT_BUNDLE_IDENTIFIER = "com.theRocketScienceGroup.Mailchimp-SDKTests";
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SWIFT_VERSION = 5.0;
@@ -578,6 +579,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
+				MARKETING_VERSION = 0.1.5;
 				PRODUCT_BUNDLE_IDENTIFIER = "com.theRocketScienceGroup.Mailchimp-SDKTests";
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SWIFT_VERSION = 5.0;

fastlane/Fastfile

@@ -17,19 +17,24 @@ fastlane_require 'fileutils'
 
 default_platform(:ios)
 
-workspace_name = "MailchimpSDK.xcworkspace"
-sdk_scheme_name = "MailchimpSDK"
+project_name = "MailchimpSDK"
+workspace_name = "#{project_name}.xcworkspace"
+sdk_scheme_name = project_name
+project_file_path = "#{project_name}/#{project_name}.xcodeproj/"
+podspec_path = "#{project_name}.podspec"
 build_path = "../build"
 deploy_path = "../deploy"
 device_archive_path = "#{build_path}/MailchimpDeviceSDK.xcarchive"
 simulator_archive_path = "#{build_path}/MailchimpSimulatorSDK.xcarchive"
-framework_name = "MailchimpSDK"
-xcframework_file_name = "MailchimpSDK.xcframework"
+framework_name = project_name
+xcframework_file_name = "#{project_name}.xcframework"
 xcframework_output_path = "#{build_path}/#{xcframework_file_name}"
 deploy_zip = "Mailchimp-SDK-iOS.zip"
 changelog_path = "../Changelog.md"
 readme_path = "../README.md"
 license_path = "../LICENSE"
+change_types = %w(Added Changed Deprecated Removed Fixed Security)
+changelog_insertion_line = 6
 
 platform :ios do
   desc "Builds the SDK framework"
@@ -59,13 +64,10 @@ platform :ios do
     sh("cd #{output_path}/#{xcframework_file_name}; find . -name '*.swiftinterface' -exec sed -i -e 's/MailchimpSDK\\.//g' {} \\;")
   end
 
-  desc "Create a release candidate for a given version"
-  lane :release do |args|
-    # Check for version argument
-    version = args[:version] || ENV['MAILCHIMP_SDK_VERSION'] || marketing_version
-    if version.nil?
-      UI.user_error! "Version not provided through argument, environment variable, or release branch name. Try running: `fastlane release version:MAJOR.MINOR.PATCH` or setting the environment variable named MAILCHIMP_SDK_VERSION, where MAJOR.MINOR.PATCH represents the version number."
-    end
+  desc "Create a release candidate"
+  lane :release do
+    # Always use MARKETING_VERSION for a Release Candidate. Use `set_version` to update MARKETING_VERSION
+    version = marketing_version
 
     # Clean up previous runs
     clean
@@ -105,6 +107,60 @@ platform :ios do
     # Remove any previous zipped SDK products
     FileUtils.remove_file("../#{deploy_zip}", force = true)
   end
+
+desc "Sets the SDK version in all files"
+  lane :set_version do
+    version = prompt(text: "Enter version number:").gsub(/^v/, '')
+
+    # Set MARKETING_VERSION using `versioning` plugin
+    increment_version_number_in_xcodeproj(
+      version_number: version,
+      xcodeproj: project_file_path
+    )
+    UI.message "MARKETING_VERSION updated to #{version}"
+
+    version_bump_podspec(path: podspec_path, version_number: version)
+    UI.message "Podspec version updated to #{version}"
+
+    UI.important "You will now update the Changelog. You will be prompted to add entries for any of the available change types. See https://keepachangelog.com/en/1.0.0/ for format."
+
+    today = DateTime.now.strftime("%Y-%m-%d")
+    changelog_changes = ["## [#{version}] - #{today}"]
+    included_change_type_index = 0 # For keeping track of which change types we include to format empty lines correctly
+
+    change_types.each { |type|
+      input = prompt(text: "Include entry for `#{type}`?", boolean: true)
+      if (input)
+        if (included_change_type_index > 0)
+          changelog_changes << "" # Add an extra line between change type sections
+        end
+
+        included_change_type_index += 1
+        changelog_changes << "### #{type}" # Add change type title
+
+        finished = false
+        while(!finished)
+          entry = prompt(text: "Type your entry for `#{type}`: ")
+          entry = '- ' + entry unless entry.start_with?('-') # Attach the - prefix if needed
+          changelog_changes << entry # Add line to total changes
+
+          additional_input = prompt(text: "Any additional entries for `#{type}`?", boolean: true)
+          finished = !additional_input # If additional entries is true, we are NOT finished
+        end
+      end
+    }
+    changelog_changes << "" # Add a trailing new line to separate from previous sections
+
+    changelog_lines = File.open(changelog_path).readlines
+    changelog_lines.insert(changelog_insertion_line, changelog_changes) # Insert the changes
+
+    # Write out the Changelog including the additions, line by line
+    File.open(changelog_path, "w+") do |f|
+      changelog_lines.each { |element| f.puts(element) }
+    end
+
+    UI.message "#{changelog_path} has been updated."
+  end
 end
 
 def output_path

fastlane/Pluginfile

@@ -0,0 +1,5 @@
+# Autogenerated by fastlane
+#
+# Ensure this file is checked in to source control!
+
+gem 'fastlane-plugin-versioning'

fastlane/README.md

@@ -35,12 +35,17 @@ Create Swift Binary Framework
 ```
 fastlane ios release
 ```
-Create a release candidate for a given version
+Create a release candidate
 ### ios clean
 ```
 fastlane ios clean
 ```
 Clean deploy artifacts
+### ios set_version
+```
+fastlane ios set_version
+```
+Sets the SDK version in all files
 
 ----