Class: Fastlane::Actions::SnapshotAction

Inherits:
Fastlane::Action show all
Defined in:
lib/fastlane/actions/snapshot.rb

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, authors, details, output, return_value, sh, step_text

Class Method Details

.author ⇒ Object 



69
70
71
 
# File 'lib/fastlane/actions/snapshot.rb', line 69

def self.author
  "KrauseFx"
end

.available_options ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/fastlane/actions/snapshot.rb', line 42

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :noclean,
                                 env_name: "FL_SNAPSHOT_NO_CLEAN",
                                 description: "Skips the clean process when building the app",
                                 is_string: false,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :verbose,
                                 env_name: "FL_SNAPSHOT_VERBOSE",
                                 description: "Print out the UI Automation output",
                                 is_string: false,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :snapshot_file_path,
                                 env_name: "FL_SNAPSHOT_CONFIG_PATH",
                                 description: "Specify a path to the directory containing the Snapfile",
                                 default_value: FastlaneFolder.path || Dir.pwd, # defaults to fastlane folder
                                 verify_block: proc do |value|
                                   raise "Couldn't find folder '#{value}'. Make sure to pass the path to the directory not the file!".red unless File.directory?(value)
                                 end),
    FastlaneCore::ConfigItem.new(key: :nobuild,
                                 env_name: "FL_SNAPSHOT_NO_BUILD",
                                 description: "Skip the build process and use a pre-built .app under your build_dir",
                                 is_string: false,
                                 default_value: false)
  ]
end

.description ⇒ Object 



38
39
40
 
# File 'lib/fastlane/actions/snapshot.rb', line 38

def self.description
  "Generate new localised screenshots on multiple devices"
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


73
74
75
 
# File 'lib/fastlane/actions/snapshot.rb', line 73

def self.is_supported?(platform)
  platform == :ios
end

.run(params) ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/fastlane/actions/snapshot.rb', line 8

def self.run(params)
  $verbose = true if params[:verbose]
  clean = !params[:noclean]
  build = !params[:nobuild]

  if Helper.test?
    Actions.lane_context[SharedValues::SNAPSHOT_SCREENSHOTS_PATH] = Dir.pwd
    return clean
  end

  require 'snapshot'

  FastlaneCore::UpdateChecker.start_looking_for_update('snapshot') unless Helper.is_test?

  ENV['SNAPSHOT_SKIP_OPEN_SUMMARY'] = "1" # it doesn't make sense to show the HTML page here

  begin
    Dir.chdir(params[:snapshot_file_path] || FastlaneFolder.path) do
      Snapshot::SnapshotConfig.shared_instance
      Snapshot::Runner.new.work(clean: clean, build: build)

      results_path = Snapshot::SnapshotConfig.shared_instance.screenshots_path

      Actions.lane_context[SharedValues::SNAPSHOT_SCREENSHOTS_PATH] = File.expand_path(results_path) # absolute URL
    end
  ensure
    FastlaneCore::UpdateChecker.show_update_status('snapshot', Snapshot::VERSION)
  end
end