Merge pull request #54 from smartmobilefactory/nightly

Nightly

Author: tschob

.version_readmes/danger_comment_example.png

@@ -0,0 +1,217 @@
+# SMF iOS Fastlane Commons - Release Notes v0.2.0
+
+## New Features
+
+### #1 Danger
+
+All Pull Requests will be analysed with [Danger](http://danger.systems) per default now!
+
+
+###### Example: Danger report in the Strato macOS App
+<img width="400" alt="danger_comment_example" src="./danger_comment_example.png">
+
+The following checks are performed and displayed in the pull request by default:
+
+- Xcode warnings and errors
+- GitHub PR length
+- Code Coverage for modified files
+- Total Code Coverage
+- SwiftLint warnings for modified files
+
+All checks can be disabled and modified in the configuration json:
+
+```json
+...
+
+"danger_config": {
+  "xcode_build_warnings.use_feature": false,
+}
+
+...
+```
+
+The following default values are used otherwise:
+
+```json
+{
+      "xcode_build_warnings.use_feature": true,
+      "github.pr.big_length.use_feature": true,
+      "github.pr.big_length.lines_of_code": 10000,
+      "code_coverage.slather.use_feature": true,
+      "code_coverage.slather.notify_if_coverage_is_less_than": 0,
+      "code_coverage.slather.notify_if_modified_file_is_less_than": 0,
+      "code_coverage.slather.notify_level": "fail",
+      "swiftlint.use_feature": true,
+      "swiftlint.fail_on_error": true
+}
+```
+
+If Danger shouldn't be performed, the file `Dangerfile` has to be removed from the project.
+
+##### Known issues
+
+- Code Coverage doesn't reflect the real coverage for framework projects
+
+### #2 Xcode warnings, SwiftLint reports and Code Coverage is stored in MetaJSON
+
+Xcode warnings, SwiftLint reports and Code Coverage is stored in MetaJSON once the app is deployed. These information is not yet used but might be added to status boards and Confluence later.
+
+##### Known issues
+
+- Code Coverage doesn't reflect the real coverage for framework projects
+
+### #3 Better notifications - especially for builds with multiple build variants in a row and iTunes Connect uploads
+
+HipChat and mail notifications are now send directly after some events happened and not at the end of the build job. See Breaking changes #1 for more details.
+
+### #4 Device and Simulator builds can be attached to GitHub release to enable separated UI-Tests
+
+Device and Simulator builds can be attached to GitHub releases to be used for UI-Tests later.
+
+###### Example: GitHub release with attached build outputs
+<img width="400" alt="github_release_with_build_outputs" src="./github_release_with_build_outputs.png">
+
+You need to enable this feature in the configuration json:
+
+```json
+...
+
+"build_variants": {
+	"hidrive_alpha": {
+    	...
+		"attach_build_outputs_to_github"	: true
+	},
+	
+...
+```
+
+### #5 Added some custom prechecks before building apps for iTunes Connect
+
+Build jobs will now directly be aborted before even building the app if the projects marketing version is not existing and editable in iTunes Connect.
+This prevents errors after the app is uploaded like: The app version is already in sale.
+
+
+## Breaking changes
+
+### #1 Success and error messages are now handled by the Fastlane Commons code
+
+Instead of sending error or success notifications once in the end of the build jobs, Fastlane Commons sends them now directly after certain events happen during the build job. This enables eg. build jobs which build multiple build variants in a row. After each build variants was build a notification is send, not only one once the build job has completed.
+
+The notifications have to enabled in lanes if they are wanted before calling the real logic:
+
+```ruby
+smf_set_should_send_deploy_notifications(true)
+
+```
+
+### #2 The complete Fastlane Commons repo is downloaded temporarily during the build process
+
+Until now it was only possible to download Fastlane Action files and one Fastfile during the build process. This blocked us to move more code and files into the Fastlane Commons repo. With this release the complete Fastlane Commons repo is downloaded temporarily into the project which enables us to split the Fastlane code into multiple files and also use other default files like a Gemfile or Dangerfile.
+
+The projects need to declare the Fastlane commons branch (`fastlane_commons_branch`) which should be used in the configurations JSON:
+
+```json
+...
+
+"project": {
+	"project_name"				: "SelfieStar",
+	"hipchat_channel"			: "Selfie iOS",
+	"fastlane_commons_branch"	: "master"
+},
+
+...
+```
+
+Also the download of the Commons repo has to be triggered in the projects Fastfile:
+
+```ruby
+config = JSON.parse(File.read('Config.json'))
+
+before_all do
+  # Import the Fastlane Commons Repo
+  fastlane_commons_branch = config["project"]["fastlane_commons_branch"]
+  import_from_git(url: "git@github.com:smartmobilefactory/SMF-iOS-Fastlane-Commons.git", branch: fastlane_commons_branch)
+end
+```
+
+### #3 In order to run Danger during PR checks a minimum commit of SMF-iOS-CommonProjectSetupFiles is needed
+
+As SwiftLint was disabled for release builds before, at least the commit `b1b13b17655b91e25c7a06ba0d25751efb5a7fdd` of SMF-iOS-CommonProjectSetupFiles is needed if Danger is used (which is done by default).
+
+### #4 Gemfile and Dangerfile are required
+
+Danger requires the usage of a Gemfile and Dangerfile. They only need to contain code which refers to the shared Gemfile and Dangerfile which is contained in the Fastlane commons repo.
+
+**Dangerfile**
+
+```ruby
+# Import the Dangerfile of the SMF-iOS-Fastlane commons repo
+fastlane_commmons_folder = ENV['FASTLANE_COMMONS_FOLDER']
+danger.import_dangerfile(path: "#{fastlane_commmons_folder}/danger")
+
+# Add custom logic here
+```
+
+**Gemfile**
+
+```ruby
+source "https://rubygems.org"
+
+gem 'fastlane'
+gem 'cocoapods'
+
+gemfile_local = './.fastlane-smf-commons/danger/Gemfile'
+
+if File.readable?(gemfile_local)
+  instance_eval(File.read(gemfile_local))
+end
+```
+
+### #5 The configuration json is used instead of lane parameters if possible
+
+Allmost all lane parameters are replaced by direct configuration json access deep inside the Fastlane Commons code. This is needed in some parts eg. for Danger where no direct access to the Fastlane Ruby code is given. It results in a more streamlined and clear configuration usage with one source of truth: the configuration json. Also the introduction of new features will require less changes in a project as all Fastlane Commons code has access to the configuration.
+
+#### a) The path to the Fastlane configuration has to be provided
+
+The projects Fastfile has to provide a lane which returns the path to the configuration json (formerly BuildVariants.json).
+
+```ruby
+private_lane :fastlane_config_path do
+  # Return the path to the Fastlane config file
+  "#{Dir.pwd}/Config.json"
+end
+```
+
+#### b) The build variant, git branch and notification setting has to be set before logic can be called
+
+At least the build variant has to be set before any logic can be called. 
+
+```ruby
+lane :check_pr do
+    
+  smf_set_build_variant("alpha")
+
+  # Now we can call the real logic - without providing any other configuration
+  smf_check_pr
+end
+```
+
+When deploying apps or publishing pods also the notification setting and git branch has to be set.
+
+```ruby
+lane :deploy_app do |options|
+
+  smf_set_should_send_deploy_notifications(true)
+
+  smf_set_git_branch(options[:branch])
+  smf_set_build_variant(options[:build_variant])
+    
+  # Now we can call the real logic - without providing any other configuration
+  smf_deploy_app
+end
+```
+
+## Improvements
+
+Many small bug fixes
+

.version_readmes/github_release_with_build_outputs.png

@@ -0,0 +1,153 @@
+############################
+###### General config ######
+############################
+
+ENV['BUILD_VARIANT'] == nil ? build_variant = "" : build_variant = ENV['BUILD_VARIANT']
+ENV['FASTLANE_CONFIG_PATH'] == nil ? fastlane_config_path = "fastlane/Config.json" : fastlane_config_path = ENV['FASTLANE_CONFIG_PATH']
+ENV['DID_RUN_UNIT_TESTS'] == nil ? did_run_unit_tests = "false" : did_run_unit_tests = ENV['DID_RUN_UNIT_TESTS']
+
+@project_danger_config = nil
+@commons_danger_config = nil
+
+message("Analysing build variant <b>#{build_variant}</b>")
+
+configuration_message = ""
+
+if File.file?(fastlane_config_path)
+  fastlane_config = JSON.parse(File.read(fastlane_config_path), :symbolize_names => true)
+  build_variant_config = fastlane_config[:build_variants][build_variant.to_sym]
+  target_depended_config = build_variant_config[:danger_config_name]
+  if target_depended_config
+    @project_danger_config = fastlane_config[target_depended_config.to_sym]
+  else
+    @project_danger_config = fastlane_config[:danger_config]
+  end
+else
+  fail "Error: SMF Fastlane config couldn't be found in #{ENV['FASTLANE_CONFIG_PATH']}"
+end
+
+if File.file?("#{ENV['FASTLANE_COMMONS_FOLDER']}/danger/danger_defaults.json")
+  @commons_danger_config = JSON.parse(File.read("#{ENV['FASTLANE_COMMONS_FOLDER']}/danger/danger_defaults.json"), :symbolize_names => true)
+  if @commons_danger_config.nil?
+      fail "The default Danger config is nil"
+  end
+else
+  fail "The Fastlane commons repo doesn't contain danger/danger_defaults.json"
+end
+
+###################
+##### Helpers #####
+###################
+
+def get_config_value(key)
+  if @project_danger_config != nil && @project_danger_config[key.to_sym] != nil
+    return @project_danger_config[key.to_sym]
+  else
+    if @commons_danger_config == nil
+      return nil
+    else
+      return @commons_danger_config[key.to_sym]
+    end
+  end
+end
+
+#####################
+###### General ######
+#####################
+
+if get_config_value("github.pr.big_length.use_feature")
+  if git.lines_of_code > get_config_value("github.pr.big_length.lines_of_code")
+    warn("There amount of changed code is huge (#{git.lines_of_code} lines). Please try to create many small pull requests instead of a few big ones!")
+  end
+  configuration_message += "<br />GitHub PR length is <b>enabled</b><br />- lines_of_code: <b>#{get_config_value("github.pr.big_length.lines_of_code")}</b>"
+else
+  configuration_message += "<br />GitHub PR length is <b>disabled</b>"
+end
+
+###################
+###### Xcode ######
+###################
+
+if get_config_value("xcode_build_warnings.use_feature")
+  if File.file?("build/reports/errors.json")
+    xcode_summary.report 'build/reports/errors.json'
+    configuration_message += "<br /><br />Xcode warnings are <b>enabled</b>"
+  else
+    configuration_message += "<br /><br />Xcode warnings are <b>disabled</b> as the build output couldn't be found"
+  end
+else
+  configuration_message += "<br /><br />Xcode warnings are <b>disabled</b>"
+end
+
+#######################
+###### Swiftlint ######
+#######################
+
+if get_config_value("swiftlint.use_feature")
+  # Use the SwiftLint Pod if available. Otherwise the SwiftLint version from the Danger plugin is used.
+  fail_on_error = get_config_value("swiftlint.fail_on_error")
+  pods_swiftlint_binary = "Pods/SwiftLint/swiftlint"
+  if File.file?(pods_swiftlint_binary)
+    expanded_binary_path = File.expand_path(pods_swiftlint_binary)
+    swiftlint.binary_path = expanded_binary_path
+  end
+
+  swiftlint_config_message = "Exists in project"
+  if File.file?(".swiftlint.yml")
+    swiftlint.config_file = File.expand_path(".swiftlint.yml")
+  end
+
+  # Run SwiftLint 
+  if fail_on_error
+    swiftlint.lint_files fail_on_error: true
+  else
+    swiftlint.lint_files
+  end
+
+  swiftlint.verbose = true
+
+  configuration_message += "<br /><br />SwiftLint is <b>enabled</b> (modified files only)<br />- binary: <b>#{swiftlint.binary_path}</b>,<br />- fail_on_error: <b>#{fail_on_error}</b>,<br />- SwiftLint configuration: <b>#{swiftlint.config_file}</b>"
+else
+  configuration_message += "<br /><br />SwiftLint is <b>disabled</b>"
+end
+
+#####################
+###### Slather ######
+#####################
+
+if get_config_value("code_coverage.slather.use_feature")
+  perform_unit_tests = (build_variant_config["pr.perform_unit_tests".to_sym].nil? ? true : build_variant_config["pr.perform_unit_tests".to_sym])
+  if perform_unit_tests && did_run_unit_tests == "true"
+
+    project_name = fastlane_config[:project][:project_name]
+    scheme = build_variant_config[:scheme]
+
+    slather.configure("#{project_name}.xcodeproj", scheme, options: {
+      workspace: "#{project_name}.xcworkspace",
+      output_directory: 'build/reports',
+    })
+
+    min_total_coverage = get_config_value("code_coverage.slather.notify_if_coverage_is_less_than").to_i
+    min_file_coverage = get_config_value("code_coverage.slather.notify_if_modified_file_is_less_than").to_i
+    notify_level_string = get_config_value("code_coverage.slather.notify_level")
+    notify_level = notify_level_string == "warn" ? :warn : :fail
+
+    slather.notify_if_coverage_is_less_than(minimum_coverage: min_total_coverage, notify_level: notify_level)
+    slather.notify_if_modified_file_is_less_than(minimum_coverage: min_file_coverage, notify_level: notify_level)
+    slather.show_coverage
+
+    configuration_message += "<br /><br />Slather is <b>enabled</b><br />- notify_if_coverage_is_less_than: <b>#{min_total_coverage}</b><br />- notify_if_modified_file_is_less_than: <b>#{min_file_coverage}</b><br />- notify_level: <b>#{notify_level_string}</b>"
+  elsif did_run_unit_tests == "false"
+    configuration_message += "<br /><br />Slather is <b>disabled</b> as unit tests weren't runned during the PR check"
+  else
+    configuration_message += "<br /><br />Slather is <b>disabled</b> as unit tests shouldn't be runned"
+  end
+else
+  warn("Slather is <b>disabled</b>")
+end
+
+# Put the configuration message inside an expandable element
+configuration_message = "<details><summary>Danger configuration:</summary>#{configuration_message}</details>"
+
+message(configuration_message)
+

.version_readmes/relase_notes-0.2.0.md

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem 'danger'
+gem 'slather'
+gem 'danger-swiftlint'
+gem 'danger-xcode_summary'
+gem 'danger-slather'
+gem 'xcpretty-json-formatter'

.version_readmes/relase_notes-0.2.0.pdf

@@ -0,0 +1,11 @@
+{
+      "xcode_build_warnings.use_feature": true,
+      "github.pr.big_length.use_feature": true,
+      "github.pr.big_length.lines_of_code": 10000,
+      "code_coverage.slather.use_feature": true,
+      "code_coverage.slather.notify_if_coverage_is_less_than": 0,
+      "code_coverage.slather.notify_if_modified_file_is_less_than": 0,
+      "code_coverage.slather.notify_level": "fail",
+      "swiftlint.use_feature": true,
+      "swiftlint.fail_on_error": true
+}