Class: Fastlane::Actions::ReleaseIosSdkAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.available_options ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/fastlane/plugin/stream_actions/actions/release_ios_sdk.rb', line 80

def self.available_options
  [
    FastlaneCore::ConfigItem.new(
      key: :version,
      description: 'Release version (not required if release type is set)',
      optional: true
    ),
    FastlaneCore::ConfigItem.new(
      key: :bump_type,
      description: 'Release type (not required if release version is set)',
      optional: true
    ),
    FastlaneCore::ConfigItem.new(
      key: :sdk_names,
      description: 'SDK names to release',
      is_string: false,
      verify_block: proc do |sdks|
        UI.user_error!("SDK names array has to be specified") unless sdks.kind_of?(Array) && sdks.size.positive?
      end
    ),
    FastlaneCore::ConfigItem.new(
      env_name: 'GITHUB_REPOSITORY',
      key: :github_repo,
      description: 'Github repository name'
    ),
    FastlaneCore::ConfigItem.new(
      env_name: 'GITHUB_TOKEN',
      key: :github_token,
      description: 'GITHUB_TOKEN environment variable'
    ),
    FastlaneCore::ConfigItem.new(
      key: :check_git_status,
      description: 'Ensure git status is clean',
      is_string: false,
      default_value: true
    ),
    FastlaneCore::ConfigItem.new(
      key: :check_release_branch,
      description: 'Ensure git branch is main',
      is_string: false,
      default_value: true
    ),
    FastlaneCore::ConfigItem.new(
      key: :skip_pod_list,
      description: 'Skip pod lib lint action',
      is_string: false,
      default_value: false
    ),
    FastlaneCore::ConfigItem.new(
      key: :pod_sync,
      description: 'If validation depends on other recently pushed pods, synchronize',
      is_string: false,
      default_value: false
    ),
    FastlaneCore::ConfigItem.new(
      key: :changelog_path,
      env_name: 'FL_CHANGELOG_PATH',
      description: 'The path to your project CHANGELOG.md',
      is_string: true,
      default_value: './CHANGELOG.md'
    )
  ]
end

.commit_changes(version_number) ⇒ Object 



62
63
64
65
66
67
68
69
70
 
# File 'lib/fastlane/plugin/stream_actions/actions/release_ios_sdk.rb', line 62

def self.commit_changes(version_number)
  sh("git add -A")
  UI.user_error!("Not committing changes") unless other_action.prompt(text: "Will commit changes. All looking good?", boolean: true)

  sh("git commit -m 'Bump #{version_number}'")
  UI.user_error!("Not pushing changes") unless other_action.prompt(text: "Will push changes. All looking good?", boolean: true)

  other_action.push_to_git_remote(tags: true)
end

.description ⇒ Object 



76
77
78
 
# File 'lib/fastlane/plugin/stream_actions/actions/release_ios_sdk.rb', line 76

def self.description
  'Releases iOS SDKs to GitHub and CocoaPods'
end

.ensure_everything_is_set_up(params) ⇒ Object 



45
46
47
48
49
50
51
52
 
# File 'lib/fastlane/plugin/stream_actions/actions/release_ios_sdk.rb', line 45

def self.ensure_everything_is_set_up(params)
  other_action.ensure_git_branch(branch: 'main') if params[:check_release_branch]
  other_action.ensure_git_status_clean if params[:check_git_status]

  if params[:version].nil? && !["patch", "minor", "major"].include?(params[:bump_type])
    UI.user_error!("Please use type parameter with one of the options: type:patch, type:minor, type:major")
  end
end

.ensure_release_tag_is_new(version_number) ⇒ Object 



54
55
56
57
58
59
60
 
# File 'lib/fastlane/plugin/stream_actions/actions/release_ios_sdk.rb', line 54

def self.ensure_release_tag_is_new(version_number)
  if other_action.git_tag_exists(tag: version_number)
    UI.user_error!("Tag for version #{version_number} already exists!")
  else
    UI.success("Ignore the red warning above. Tag for version #{version_number} is alright!")
  end
end

.run(params) ⇒ Object 



4
5
6
7
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
37
38
39
40
41
42
43
 
# File 'lib/fastlane/plugin/stream_actions/actions/release_ios_sdk.rb', line 4

def self.run(params)
  ensure_everything_is_set_up(params)

  version_number = ''
  params[:sdk_names].each do |target|
    version_number = other_action.increment_version_number_in_plist(
      target: target,
      version_number: params[:version],
      bump_type: params[:bump_type]
    )
  end

  ensure_release_tag_is_new(version_number)

  changes = other_action.read_changelog(version: version_number, changelog_path: params[:changelog_path])

  podspecs = []
  params[:sdk_names].each { |sdk| podspecs << "#{sdk}.podspec" }

  podspecs.each do |podspec|
    UI.user_error!("Podspec #{podspec} does not exist!") unless File.exist?(podspec)
    other_action.pod_lib_lint(podspec: podspec, allow_warnings: true) unless params[:skip_pod_list]
    other_action.version_bump_podspec(path: podspec, version_number: version_number)
  end

  commit_changes(version_number)

  release_details = other_action.set_github_release(
    repository_name: params[:github_repo],
    api_token: params[:github_token],
    name: version_number,
    tag_name: version_number,
    description: changes,
    commitish: ENV['BRANCH_NAME'] || other_action.git_branch
  )

  podspecs.each { |podspec| other_action.pod_push_safely(podspec: podspec, sync: params[:pod_sync] & true) }

  UI.success("Github release v#{version_number} was created, please visit #{release_details['html_url']} to see it! 🚢")
end

.supported?(_platform) ⇒ Boolean

Returns:

  • (Boolean) 


144
145
146
 
# File 'lib/fastlane/plugin/stream_actions/actions/release_ios_sdk.rb', line 144

def self.supported?(_platform)
  [:ios].include?(platform)
end