Class: Fastlane::Actions::ReactNativeReleaseAction

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

Constant Summary collapse

VALID_RELEASE_TYPES = 
%w{beta release hotfix}

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



131
132
133
 
# File 'lib/fastlane/plugin/react_native_release/actions/react_native_release.rb', line 131

def self.authors
  ["cball", "isaiahgrey93"]
end

.available_options ⇒ Object 



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/fastlane/plugin/react_native_release/actions/react_native_release.rb', line 143

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :xcodeproj,
                            env_name: "REACT_NATIVE_RELEASE_XCODE_PROJECT",
                         description: "Path to Xcode project",
                            optional: true,
                                type: String,
                       default_value: "#{Dir.pwd}/#{Dir['**/*.xcodeproj'].sort.first}",
                        verify_block: lambda do |value|
                                        UI.user_error!("Could not find Xcode project") unless File.exist?(value)
                                      end),
    FastlaneCore::ConfigItem.new(key: :android_app_dir,
                            env_name: "REACT_NATIVE_RELEASE_ANDROID_APP_DIR",
                         description: "Path to Android app dir",
                            optional: true,
                                type: String,
                       default_value: "#{Dir.pwd}/android/app",
                        verify_block: lambda do |value|
                                        UI.user_error!("Could not find specified Android app dir") unless File.exist?(value)
                                      end),
    FastlaneCore::ConfigItem.new(key: :alpha_branch,
                            env_name: "REACT_NATIVE_RELEASE_ALPHA_BRANCH",
                         description: "The branch used for alpha releases",
                            optional: true,
                                type: String,
                       default_value: 'master'),
    FastlaneCore::ConfigItem.new(key: :beta_branch,
                            env_name: "REACT_NATIVE_RELEASE_BETA_BRANCH",
                         description: "The branch used for beta releases",
                            optional: true,
                                type: String,
                       default_value: 'beta'),
    FastlaneCore::ConfigItem.new(key: :production_branch,
                            env_name: "REACT_NATIVE_RELEASE_PRODUCTION_BRANCH",
                         description: "The branch used for production releases",
                            optional: true,
                                type: String,
                       default_value: 'production'),
    FastlaneCore::ConfigItem.new(key: :target,
                            env_name: "REACT_NATIVE_RELEASE_TARGET",
                         description: "The release target. Valid targets are #{VALID_TARGETS.join(', ')}",
                            optional: true,
                                type: String,
                        verify_block: lambda do |value|
                                        unless VALID_TARGETS.find{|v| value == v}
                                          UI.user_error!("Invalid target #{value}. Valid targets are #{VALID_TARGETS.join(', ')}") 
                                          next
                                        end
                                      end), 
    FastlaneCore::ConfigItem.new(key: :hotfix,
                            env_name: "REACT_NATIVE_RELEASE_HOTFIX",
                         description: "If this is a hotfix. Will only pull the latest branch and tag",
                            optional: true,
                                type: Boolean,
                       default_value: false),
    FastlaneCore::ConfigItem.new(key: :prompt_for_version_bump,
                            env_name: "REACT_NATIVE_RELEASE_PROMPT_FOR_VERSION_BUMP",
                         description: "Force the prompt to bump the app version. Otherwise, only prompts on beta",
                            optional: true,
                                type: Boolean,
                       default_value: false),
  ]
end

.bump_android_version(options) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/fastlane/plugin/react_native_release/actions/react_native_release.rb', line 102

def self.bump_android_version(options)
  version_bump = options[:version] || prompt_for_version
  return if version_bump == "none"

  UI.message "bumping android to #{version_bump}"
  other_action.increment_version_name(
    # TODO: make param
    app_project_dir: "#{Dir.pwd}/android/app",
    bump_type: version_bump
  )
end

.bump_ios_version(options) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
 
# File 'lib/fastlane/plugin/react_native_release/actions/react_native_release.rb', line 91

def self.bump_ios_version(options)
  version_bump = options[:version] || prompt_for_version
  return if version_bump == "none"

  UI.message "bumping ios #{options[:xcodeproj]} to #{version_bump}"
  other_action.increment_version_number(
    xcodeproj: options[:xcodeproj],
    bump_type: version_bump
  )
end

.description ⇒ Object 



127
128
129
 
# File 'lib/fastlane/plugin/react_native_release/actions/react_native_release.rb', line 127

def self.description
  "Simplify releases for React Native apps"
end

.details ⇒ Object 



139
140
141
 
# File 'lib/fastlane/plugin/react_native_release/actions/react_native_release.rb', line 139

def self.details
  "Creates a release for a React Native app. Handles incrementing versions and tags"
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


207
208
209
210
211
212
 
# File 'lib/fastlane/plugin/react_native_release/actions/react_native_release.rb', line 207

def self.is_supported?(platform)
  # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
  # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
  #
  [:ios, :android].include?(platform)
end

.merge_branch(options) ⇒ Object

Handles merging the specified branch into a target. example: beta -> master



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/fastlane/plugin/react_native_release/actions/react_native_release.rb', line 75

def self.merge_branch(options)
  branch = options[:branch]
  target = options[:target]

  sh "git checkout #{target}"
  sh "git merge origin/#{branch} --no-ff -m 'chore(release): Merge #{branch} -> #{target} [skip ci]' " do |status|
    unless status.success?
      UI.error "Failed to merge #{branch} into #{target}"
    end
    
    other_action.push_to_git_remote(
      local_branch: target  
    )
  end
end

.prompt_for_version ⇒ Object 



122
123
124
 
# File 'lib/fastlane/plugin/react_native_release/actions/react_native_release.rb', line 122

def self.prompt_for_version
  UI.select("Update Version?: ", ["none", "major", "minor", "patch"])
end

.return_value ⇒ Object 



135
136
137
 
# File 'lib/fastlane/plugin/react_native_release/actions/react_native_release.rb', line 135

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

.run(params) ⇒ Object

params: release_type, alpha_branch, beta_branch, release_branch, hotfix_destination



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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/fastlane/plugin/react_native_release/actions/react_native_release.rb', line 11

def self.run(params)
  require 'fastlane/plugin/android_versioning'
  other_action.create_fastlane_session

  release_type = params[:release_type] || UI.select("Select a release type:", VALID_RELEASE_TYPES)
  is_beta = release_type.include?('beta')
  is_release = release_type.include?('release')
  is_hotfix = release_type.include?('hotfix')

  ios_version = other_action.get_version_number(xcodeproj: params[:xcodeproj], target: File.basename(params[:xcodeproj], '.*'))
  android_version = other_action.get_version_name(app_project_dir: params[:android_app_dir])
  should_prompt_for_version_bump = params[:prompt_for_version_bump] === true || is_beta

  if is_beta
    # TODO: ohter branches
    verify_git_branch_state(beta_branch)
  end

  # TODO: flows

  # Cut a fresh branch unless this is a hotfix
  # if !is_hotfix
  #   # delete an existing branch if we have one
  #   sh "git show-ref #{target_branch}" do |status|
  #     sh "git branch -D #{target_branch}" if status.success?
  #   end
    
  #   sh "git checkout -b #{target_branch}"
  # end

  # Tag / Bump version
  if should_prompt_for_version_bump
    version = prompt_for_version
    ios_version = bump_ios_version(version: version, xcodeproj: params[:xcodeproj])
    android_version = bump_android_version(version: version)

    if ios_version &&  android_version
      UI.message "Committing iOS v#{ios_version} and Android v#{android_version} to git"
      other_action.git_commit(
        path: ["#{Dir.pwd}/ios", "#{Dir.pwd}/android"],
        message: "Release iOS v#{ios_version} and Android v#{android_version}"
      )
    else
      UI.message "No version bump specified"
    end
  end

  # Tag it. TODO: release
  tag_name = "release/ios-#{ios_version}-android-#{android_version}"
  other_action.add_git_tag(tag: tag_name)
  # other_action.push_to_git_remote(
  #   local_branch: target_branch,
  #   force: true
  # )

  merge_branch(branch: target_branch, target: base_branch)
  return if is_beta

  # production releases need an additional merge back to the alpha branch
  merge_branch(branch: params[:beta_branch], target: params[:alpha_branch])
end

.verify_git_branch_state(branch) ⇒ Object 



114
115
116
117
118
119
120
 
# File 'lib/fastlane/plugin/react_native_release/actions/react_native_release.rb', line 114

def self.verify_git_branch_state(branch)
  # Ensure we're on the right branch and in a good state
  # other_action.ensure_git_branch(branch)
  other_action.ensure_git_status_clean
  sh "git branch --set-upstream-to=origin/#{branch} #{branch}"
  other_action.git_pull
end