fastlane 0.1.18 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c08d6deb51fb737343ca2c4ae1ce4bb55d847413
-  data.tar.gz: ab06affaf917a58a9a96b869961b00e6ce800878
+  metadata.gz: 631af16c08f15cee9b7af0fea8278741b84dde70
+  data.tar.gz: eed07c5e6b46944c88ae0f12462222153d8d0b52
 SHA512:
-  metadata.gz: bad73425aa485e3ee0a037b9d27fcf47f9de96d6079663056f596f99371eab435b3676940e6a381baf6cccc291d6a65b826f8280579cd39d31333b4e5f440f8d
-  data.tar.gz: ec15de6387730d65926ca9f49f857552d317d9f3174614647bb3deea7da4c9c9836a6309b26e9ceb496eac87f71f687d124e8dfc6a33ba4727fee3fb4e2b3ff8
+  metadata.gz: f679dec6d8d5b9cf95d78ea1a770cfb22cbb0fb13f7c0edf20b5fcecb36426ac6b2126f99f72c1b950d92c590b5b1026fb210e0c297221a7643e856de2358faa
+  data.tar.gz: 6e633288c054b437e9831536e3a62511bfa0a3c0fc2f8a0b1aa4da2b85cd222f84a6ca580afa665e5002dcea4cb3062d68185c4fd82a82cdedc3cbe16b90a331

data/README.md

@@ -55,7 +55,7 @@ Get in contact with the developer on Twitter: [@KrauseFx](https://twitter.com/Kr
 - Very flexible configuration using a fully customizable `Fastfile`
 - Once up and running, you have a fully working **Continuous Deployment** process. Just trigger ```fastlane``` and you're good to go.
 
-##### Take a look at the [fastlane website](http://fastlane.tools) for more information about why and when to use `fastlane`.
+##### Take a look at the [fastlane website](https://fastlane.tools) for more information about why and when to use `fastlane`.
 
 ##### [Like this tool? Be the first to know about updates and new fastlane tools](https://tinyletter.com/krausefx)
 
@@ -257,6 +257,90 @@ increment_build_number # automatically increment by one
 increment_build_number '75' # set a specific number
 ```
 
+#### [resign]
+This will resign an ipa with another signing identity and provisioning profile.
+
+If you have used the `ipa` and `sigh` actions, then this action automatically gets the `ipa` and `provisioning_profile` values respectively from those actions and you don't need to manually set them (althout you can always override them).
+
+```ruby
+resign(
+  ipa: 'path/to/ipa', # can omit if using the `ipa` action
+  signing_identity: 'iPhone Distribution: Luka Mirosevic (0123456789)',
+  provisioning_profile: 'path/to/profile', # can omit if using the `sigh` action
+)
+```
+
+#### [clean_build_artifacts]
+This action deletes the files that get created in your repo as a result of running the `ipa` and `sigh` commands. It doesn't delete the `fastlane/report.xml` though, this is probably more suited for the .gitignore.
+
+Useful if you quickly want to send out a test build by dropping down to the command line and typing something like `fastlane beta`, without leaving your repo in a messy state afterwards.
+
+```ruby
+clean_build_artifacts
+```
+
+#### [ensure_git_status_clean]
+A sanity check to make sure you are working in a repo that is clean. Especially useful to put at the beginning of your fastfile in the `before_all` block, if some of your other actions will touch your filesystem, do things to your git repo, or just as a general reminder to save your work. Also needed as a prerequisite for some other actions like `reset_git_repo`.
+
+```ruby
+ensure_git_status_clean
+```
+
+#### [commit_version_bump]
+This action will create a "Version Bump" commit in your repo. Useful in conjunction with `increment_build_number`.
+
+It checks the repo to make sure that only the relevant files have changed, these are the files that `increment_build_number` (`agvtool`) touches:
+- All .plist files
+- The `.xcodeproj/project.pbxproj` file
+
+Then commits those files to the repo.
+
+Customise the message with the `:message` option, defaults to "Version Bump"
+
+If you have other uncommitted changes in your repo, this action will fail. If you started off in a clean repo, and used the `ipa` and or `sigh` actions, then you can use the `clean_build_artifacts` action to clean those temporary files up before running this action.
+
+```ruby
+commit_version_bump
+
+commit_version_bump(
+  message: 'New version yo!', # create a commit with a custom message
+)
+```
+
+#### [add_git_tag]
+This will automatically tag your build with the following format: `<grouping>/<lane>/<prefix><build_number>`, where: 
+- `grouping` is just to keep your tags organised under one "folder", defaults to 'builds'
+- `lane` is the name of the current fastlane lane
+- `prefix` is anything you want to stick in front of the version number, e.g. "v"
+- `build_number` is the build number, which defaults to the value emitted by the `increment_build_number` action
+
+For example for build 1234 in the "appstore" lane it will tag the commit with `builds/appstore/1234`
+
+```ruby
+add_git_tag # simple tag with default values
+
+add_git_tag(
+  grouping: 'fastlane-builds',
+  prefix: 'v',
+  build_number: 123
+)
+```
+
+#### [reset_git_repo]
+This action will reset your git repo to a clean state, discarding any uncommitted and untracked changes. Useful in case you need to revert the repo back to a clean state, e.g. after the fastlane run.
+
+It's a pretty drastic action so it comes with a sort of safety latch. It will only proceed with the reset if either of these conditions are met:
+
+- You have called the `ensure_git_status_clean` action prior to calling this action. This ensures that your repo started off in a clean state, so the only things that will get destroyed by this action are files that are created as a byproduct of the fastlane run.
+- You call it with the `:force` option, in which case "you have been warned".
+
+Also useful for putting in your `error` block, to bring things back to a pristine state (again with the caveat that you have called `ensure_git_status_clean` before)
+
+```ruby
+reset_git_repo
+reset_git_repo :force # if you don't care about warnings and are absolutely sure that you want to discard all changes. This will reset the repo even if you have valuable uncommitted changes, so use with care!
+```
+
 #### [HockeyApp](http://hockeyapp.net)
 ```ruby
 hockey({
@@ -279,7 +363,30 @@ crashlytics({
   ipa_path: './app.ipa'
 })
 ```
-Additionally you can specify `notes_path`, `emails` and `groups`.
+Additionally you can specify `notes_path`, `emails`, `groups` and `notifications`.
+
+#### AWS S3 Distribution
+
+Add the `s3` action after the `ipa` step:
+
+```ruby
+s3
+```
+
+You can also customize a lot of options:
+```ruby
+s3({
+  # All of these are used to make Shenzhen's `ipa distribute:s3` command
+  access_key: ENV['S3_ACCESS_KEY'], # Required from user
+  secret_access_key: ENV['S3_SECRET_ACCESS_KEY'], # Required from user
+  bucket: ENV['S3_BUCKET'], # Required from user
+  file: 'AppName.ipa', # This would come from IpaAction
+  dsym: 'AppName.app.dSYM.zip', # This would come from IpaAction
+  path: 'v{CFBundleShortVersionString}_b{CFBundleVersion}/' # This is actually the default
+})
+```
+
+It is recommended to **not** store the AWS access keys in the `Fastfile`.
 
 #### [DeployGate](https://deploygate.com/)
 
@@ -331,6 +438,7 @@ Send a message to **topic** with success (:smile:) or failure (:rage:) status.
 ```ruby
   typetalk({
     message: "App successfully released!",
+    note_path: 'ChangeLog.md',
     topicId: 1,
     success: true,
     typetalk_token: 'Your Typetalk Token'
@@ -472,7 +580,7 @@ Save and run. The result should look like this:
 
 # Tips
 
-## [`fastlane`](http://fastlane.tools) Toolchain
+## [`fastlane`](https://fastlane.tools) Toolchain
 
 - [`deliver`](https://github.com/KrauseFx/deliver): Upload screenshots, metadata and your app to the App Store using a single command
 - [`snapshot`](https://github.com/KrauseFx/snapshot): Automate taking localized screenshots of your iOS app on every device
@@ -512,8 +620,12 @@ before_all do |lane|
   ENV["SLACK_URL"] = "https://hooks.slack.com/services/..."
   team_id "Q2CBPK58CA"
 
+  ensure_git_status_clean
+
   increment_build_number
+
   cocoapods
+
   xctool :test
 
   ipa({
@@ -522,8 +634,12 @@ before_all do |lane|
 end
 
 lane :beta do
+  cert
+
   sigh :adhoc
+
   deliver :beta
+
   hockey({
     api_token: '...',
     ipa: './app.ipa' # optional
@@ -531,13 +647,24 @@ lane :beta do
 end
 
 lane :deploy do
+  cert
+
   sigh
+
   snapshot
+
   deliver :force
+  
   frameit
 end
 
 after_all do |lane|
+  clean_build_artifacts
+
+  commit_version_bump
+
+  add_git_tag
+
   slack({
     message: "Successfully deployed a new version."
   })
@@ -545,6 +672,8 @@ after_all do |lane|
 end
 
 error do |lane, exception|
+  reset_git_repo
+
   slack({
     message: "An error occured"
   })

data/bin/fastlane

@@ -16,7 +16,7 @@ class FastlaneApplication
     program :version, Fastlane::VERSION
     program :description, 'CLI for \'fastlane\' - Connect all iOS deployment tools into one streamlined workflow'
     program :help, 'Author', 'Felix Krause <fastlane@krausefx.com>'
-    program :help, 'Website', 'http://fastlane.tools'
+    program :help, 'Website', 'https://fastlane.tools'
     program :help, 'GitHub', 'https://github.com/krausefx/fastlane'
     program :help_formatter, :compact
 

data/lib/fastlane/actions/add_git_tag.rb

@@ -0,0 +1,20 @@
+module Fastlane
+  module Actions
+    # Adds a git tag to the current commit
+    class AddGitTagAction
+      def self.run(params)
+        params = params.first
+
+        grouping      = (params && params[:grouping]) || 'builds'
+        prefix        = (params && params[:prefix]) || ''
+        build_number  = (params && params[:build_number]) || Actions.lane_context[Actions::SharedValues::BUILD_NUMBER]
+        
+        lane_name     = Actions.lane_context[Actions::SharedValues::LANE_NAME]
+
+        Actions.sh("git tag #{grouping}/#{lane_name}/#{prefix}#{build_number}")
+
+        Helper.log.info 'Added git tag 🎯.'
+      end
+    end
+  end
+end

data/lib/fastlane/actions/clean_build_artifacts.rb

@@ -0,0 +1,15 @@
+module Fastlane
+  module Actions
+    class CleanBuildArtifactsAction
+      def self.run(_params)
+        [
+          Actions.lane_context[Actions::SharedValues::IPA_OUTPUT_PATH],
+          Actions.lane_context[Actions::SharedValues::SIGH_PROFILE_PATH],
+          Actions.lane_context[Actions::SharedValues::DSYM_OUTPUT_PATH],
+        ].reject { |file| file.nil? || !File.exist?(file) }.each { |file| File.delete(file) }
+
+        Helper.log.info 'Cleaned up build artefacts 🐙'.green
+      end
+    end
+  end
+end

data/lib/fastlane/actions/commit_version_bump.rb

@@ -0,0 +1,61 @@
+module Fastlane
+  module Actions
+    # Commits the current changes in the repo as a version bump, checking to make sure only files which contain version information have been changed.
+    class CommitVersionBumpAction
+      def self.run(params)
+        require 'xcodeproj'
+        require 'pathname'
+        require 'set'
+        require 'shellwords'
+
+        params = params.first
+
+        commit_message = (params && params[:message]) || 'Version Bump'
+
+        # find the repo root path
+        repo_path = `git rev-parse --show-toplevel`.strip
+
+        # find an xcodeproj (ignoreing the Cocoapods one)
+        xcodeproj_paths = Dir[File.expand_path(File.join(repo_path, '**/*.xcodeproj'))].reject { |path| /.*Pods.xcodeproj/ =~ path }
+
+        raise 'Could not find a .xcodeproj in the current repository\'s working directory.'.red if xcodeproj_paths.count == 0
+        raise 'Found multiple .xcodeproj projects in the current repository\'s working directory. This tool only support project folders with a single .xcodeproj.'.red if xcodeproj_paths.count > 1
+        xcodeproj_path = xcodeproj_paths.first
+
+        # find the pbxproj path, relative to git directory
+        git_pathname = Pathname.new(repo_path)
+        pbxproj_pathname = Pathname.new(File.join(xcodeproj_path, 'project.pbxproj'))
+        pbxproj_path = pbxproj_pathname.relative_path_from(git_pathname).to_s
+
+        # find the info_plist files
+        project = Xcodeproj::Project.open(xcodeproj_path)
+        info_plist_files = project.objects.select { |object| object.isa == 'XCBuildConfiguration' }.map(&:to_hash).map { |object_hash| object_hash['buildSettings'] }.select { |build_settings| build_settings.has_key?('INFOPLIST_FILE') }.map { |build_settings| build_settings['INFOPLIST_FILE'] }.uniq
+
+        # create our list of files that we expect to have changed, they should all be relative to the project root, which should be equal to the git workdir root
+        expected_changed_files = []
+        expected_changed_files << pbxproj_path
+        expected_changed_files << info_plist_files
+        expected_changed_files.flatten!.uniq!
+
+        # get the list of files that have actually changed in our git workdir
+        git_dirty_files = `git diff --name-only HEAD`.split("\n") + `git ls-files --other --exclude-standard`.split("\n")
+
+        # little user hint
+        raise 'No file changes picked up. Make sure you run the `increment_build_number` action first.'.red if git_dirty_files.empty?
+
+        # check if the files changed are the ones we expected to change (these should be only the files that have version info in them)
+        changed_files_as_expected = (Set.new(git_dirty_files) == Set.new(expected_changed_files))
+        raise "Found unexpected uncommited changes in the working directory. Expected these files to have changed: #{expected_changed_files}. But found these actual changes: #{git_dirty_files}. Make sure you have cleaned up the build artifacts and are only left with the changed version files at this stage in your lane, and don't touch the working directory while your lane is running.".red unless changed_files_as_expected
+
+        # get the absolute paths to the files
+        git_add_paths = expected_changed_files.map { |path| File.expand_path(File.join(git_pathname, path)) }
+
+        # then create a commit with a message
+        Actions.sh("git add #{git_add_paths.map(&:shellescape).join(' ')}")
+        Actions.sh("git commit -m '#{commit_message}'")
+
+        Helper.log.info "Committed \"#{commit_message}\" 💾.".green
+      end
+    end
+  end
+end

data/lib/fastlane/actions/crashlytics.rb

@@ -20,6 +20,7 @@ module Fastlane
         notes_path       = params[:notes_path]
         emails           = params[:emails]
         groups           = params[:groups]
+        notifications    = params[:notifications]
 
         assert_valid_params!(crashlytics_path, api_token, build_secret, ipa_path)
 
@@ -29,7 +30,7 @@ module Fastlane
 
         client = Shenzhen::Plugins::Crashlytics::Client.new(crashlytics_path, api_token, build_secret)
 
-        response = client.upload_build(ipa_path, file: ipa_path, notes: notes_path, emails: emails, groups: groups)
+        response = client.upload_build(ipa_path, file: ipa_path, notes: notes_path, emails: emails, groups: groups, notifications: notifications)
 
         if response
           Helper.log.info 'Build successfully uploaded to Crashlytics'.green

data/lib/fastlane/actions/ensure_git_status_clean.rb

@@ -0,0 +1,21 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      GIT_REPO_WAS_CLEAN_ON_START = :GIT_REPO_WAS_CLEAN_ON_START
+    end
+
+    # Raises an exception and stop the lane execution if the repo is not in a clean state
+    class EnsureGitStatusCleanAction
+      def self.run(_params)
+        repo_clean = `git status --porcelain`.empty?
+
+        if repo_clean
+          Helper.log.info 'Git status is clean, all good! 💪'.green
+          Actions.lane_context[SharedValues::GIT_REPO_WAS_CLEAN_ON_START] = true
+        else
+          raise 'Git repository is dirty! Please ensure the repo is in a clean state by commiting/stashing/discarding all changes first.'.red
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/actions/reset_git_repo.rb

@@ -0,0 +1,16 @@
+module Fastlane
+  module Actions
+    # Does a hard reset and clean on the repo
+    class ResetGitRepoAction
+      def self.run(params)
+        if params.include?(:force) || Actions.lane_context[SharedValues::GIT_REPO_WAS_CLEAN_ON_START]
+          Actions.sh('git reset --hard HEAD')
+          Actions.sh('git clean -qfdx')
+          Helper.log.info 'Git repo was reset and cleaned back to a pristine state.'.green
+        else
+          raise 'This is a destructive and potentially dangerous action. To protect from data loss, please add the `ensure_git_status_clean` action to the beginning of your lane, or if you\'re absolutely sure of what you\'re doing then call this action with the :force option.'.red
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/actions/resign.rb

@@ -0,0 +1,29 @@
+module Fastlane
+  module Actions
+    # Resigns the ipa
+    class ResignAction
+      def self.run(params)
+        require 'sigh'
+
+        params = params.first
+
+        raise 'You must pass valid params to the resign action. Please check the README.md'.red if (params.nil? || params.empty?)
+
+        ipa                   = params[:ipa] || Actions.lane_context[SharedValues::IPA_OUTPUT_PATH]
+        signing_identity      = params[:signing_identity]
+        provisioning_profile  = params[:provisioning_profile] || Actions.lane_context[SharedValues::SIGH_PROFILE_PATH]
+
+        raise 'Please pass a valid ipa which should be a path to an ipa on disk'.red unless ipa
+        raise 'Please pass a valid signing_identity'.red unless signing_identity
+        raise 'Please pass a valid provisioning_profile which should be a path to a profile on disk.'.red unless provisioning_profile
+
+        # try to resign the ipa
+        if Sigh::Resign.resign(ipa, signing_identity, provisioning_profile)
+          Helper.log.info 'Successfully re-signed .ipa 🔏.'.green
+        else
+          raise 'Failed to re-sign .ipa'.red
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/actions/typetalk.rb

@@ -4,6 +4,7 @@ module Fastlane
       def self.run(params)
         options = {
             message: nil,
+            note_path: nil,
             success: true,
             topicId: nil,
             typetalk_token: nil,
@@ -15,6 +16,13 @@ module Fastlane
 
         emoticon = (options[:success] ? ':smile:' : ':rage:')
         message = "#{emoticon} #{options[:message].to_s}"
+
+        note_path = File.expand_path(options[:note_path]) if options[:note_path]
+        if note_path and File.exist?(note_path)
+          contents = File.read(note_path)
+          message += "\n\n```\n#{contents}\n```"
+        end
+
         topicId = options[:topicId]
         typetalk_token = options[:typetalk_token]
 
@@ -29,7 +37,7 @@ module Fastlane
 
         uri = URI.parse("https://typetalk.in/api/v1/topics/#{topicId}")
         response = Net::HTTP.post_form(uri, {'message' => message,
-                                             'typetalk_token' => typetalk_token})
+                                             'typetalkToken' => typetalk_token})
 
         self.check_response(response)
       end

data/lib/fastlane/version.rb

@@ -1,3 +1,3 @@
 module Fastlane
-  VERSION = '0.1.18'
+  VERSION = '0.1.19'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane
 version: !ruby/object:Gem::Version
-  version: 0.1.18
+  version: 0.1.19
 platform: ruby
 authors:
 - Felix Krause
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.12.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.12.1
 - !ruby/object:Gem::Dependency
   name: slack-notifier
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: xcodeproj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: fastlane_core
   requirement: !ruby/object:Gem::Requirement
@@ -309,10 +323,14 @@ files:
 - lib/fastlane.rb
 - lib/fastlane/actions/README
 - lib/fastlane/actions/actions_helper.rb
+- lib/fastlane/actions/add_git_tag.rb
 - lib/fastlane/actions/cert.rb
+- lib/fastlane/actions/clean_build_artifacts.rb
+- lib/fastlane/actions/commit_version_bump.rb
 - lib/fastlane/actions/crashlytics.rb
 - lib/fastlane/actions/deliver.rb
 - lib/fastlane/actions/deploygate.rb
+- lib/fastlane/actions/ensure_git_status_clean.rb
 - lib/fastlane/actions/frameit.rb
 - lib/fastlane/actions/gcovr.rb
 - lib/fastlane/actions/hipchat.rb
@@ -321,6 +339,8 @@ files:
 - lib/fastlane/actions/install_cocapods.rb
 - lib/fastlane/actions/ipa.rb
 - lib/fastlane/actions/produce.rb
+- lib/fastlane/actions/reset_git_repo.rb
+- lib/fastlane/actions/resign.rb
 - lib/fastlane/actions/s3.rb
 - lib/fastlane/actions/say.rb
 - lib/fastlane/actions/sigh.rb