Class: Fastlane::Actions::CarthageOutdatedAction

Inherits:
Action
  • Object
show all
Defined in:
lib/fastlane/plugin/dependency_manager_outdated/actions/carthage_outdated_action.rb

Documentation collapse

Class Method Summary collapse

Class Method Details

.authorsObject



113
114
115
# File 'lib/fastlane/plugin/dependency_manager_outdated/actions/carthage_outdated_action.rb', line 113

def self.authors
  ["matsuda"]
end

.available_optionsObject



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# File 'lib/fastlane/plugin/dependency_manager_outdated/actions/carthage_outdated_action.rb', line 52

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :project_directory,
                                 env_name: "DEPENDENCY_MANAGER_PROJECT_DIRECTORY",
                                 description: "The path to the root of the project directory",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :use_ssh,
                                 env_name: "DEPENDENCY_MANAGER_CARTHAGE_USE_SSH",
                                 description: "Use SSH for downloading GitHub repositories",
                                 is_string: false,
                                 type: Boolean,
                                 optional: true),

    # slack
    FastlaneCore::ConfigItem.new(key: :slack_url,
                                 short_option: "-i",
                                 env_name: "DEPENDENCY_MANAGER_SLACK_URL",
                                 sensitive: true,
                                 description: "Create an Incoming WebHook for your Slack group to post results there",
                                 optional: true,
                                 verify_block: proc do |value|
                                   if !value.to_s.empty? && !value.start_with?("https://")
                                     UI.user_error!("Invalid URL, must start with https://")
                                   end
                                 end),
    FastlaneCore::ConfigItem.new(key: :slack_channel,
                                 short_option: "-e",
                                 env_name: "DEPENDENCY_MANAGER_SLACK_CHANNEL",
                                 description: "#channel or @username",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :slack_username,
                                 env_name: "DEPENDENCY_MANAGER_SLACK_USERNAME",
                                 description: "Overrides the webhook's username property if slack_use_webhook_configured_username_and_icon is false",
                                 default_value: "fastlane",
                                 is_string: true,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :slack_icon_url,
                                 env_name: "DEPENDENCY_MANAGER_SLACK_ICON_URL",
                                 description: "Overrides the webhook's image property if slack_use_webhook_configured_username_and_icon is false",
                                 default_value: "https://s3-eu-west-1.amazonaws.com/fastlane.tools/fastlane.png",
                                 is_string: true,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :skip_slack,
                                 env_name: "DEPENDENCY_MANAGER_SKIP_SLACK",
                                 description: "Don't publish to slack, even when an URL is given",
                                 is_string: false,
                                 default_value: false),
  ]
end

.descriptionObject



44
45
46
# File 'lib/fastlane/plugin/dependency_manager_outdated/actions/carthage_outdated_action.rb', line 44

def self.description
  "Check outdated Carthage dependencies"
end

.detailsObject



48
49
50
# File 'lib/fastlane/plugin/dependency_manager_outdated/actions/carthage_outdated_action.rb', line 48

def self.details
  "Check outdated Carthage dependencies"
end

.example_codeObject



121
122
123
124
125
126
127
128
129
# File 'lib/fastlane/plugin/dependency_manager_outdated/actions/carthage_outdated_action.rb', line 121

def self.example_code
  [
    'carthage_outdated',
    'carthage_outdated(
      project_directory: "path/to/xcode/project",
      slack_url: "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX",
    )',
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean)


117
118
119
# File 'lib/fastlane/plugin/dependency_manager_outdated/actions/carthage_outdated_action.rb', line 117

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

.outputObject



102
103
104
105
106
107
# File 'lib/fastlane/plugin/dependency_manager_outdated/actions/carthage_outdated_action.rb', line 102

def self.output
  [
    ['CARTHAGE_OUTDATED_LIST', 'List of the outdated dependencies in the current Cartfile.resolved'],
    ['CARTHAGE_REPOSITORY_LIST', 'List of dependencies in the current Cartfile.resolved'],
  ]
end

.return_valueObject



109
110
111
# File 'lib/fastlane/plugin/dependency_manager_outdated/actions/carthage_outdated_action.rb', line 109

def self.return_value
  # If your method provides a return value, you can describe here what it does
end

.run(params) ⇒ Object



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
37
38
# File 'lib/fastlane/plugin/dependency_manager_outdated/actions/carthage_outdated_action.rb', line 12

def self.run(params)
  UI.message("The carthage_outdated action is working!")

  DependencyManager.config = params

  cmd = ["carthage outdated"]
  cmd << "--project-directory #{params[:project_directory]}" if params[:project_directory]
  cmd << "--use-ssh" if params[:use_ssh]
  result = Actions.sh(cmd.join(' '))

  dependencies = Helper::CarthageOutdatedHelper.parse(result)

  if dependencies.empty?
    UI.success("All dependencies are up to date.")
  else
    repos = Helper::CarthageOutdatedHelper.resolved(params[:project_directory])
    Actions.lane_context[SharedValues::CARTHAGE_REPOSITORY_LIST] = repos

    dependencies.each do |lib|
      if repository = repos[lib[:name]]
        lib[:repository] = repository
      end
    end
    Actions.lane_context[SharedValues::CARTHAGE_OUTDATED_LIST] = dependencies
    Helper::CarthageOutdatedHelper.notify_slack(dependencies)
  end
end