Class: Fastlane::Actions::IncrementBuildNumberAction

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

Constant Summary

Constants inherited from Fastlane::Action

Fastlane::Action::AVAILABLE_CATEGORIES

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, authors, details, lane_context, method_missing, other_action, sample_return_value, sh, step_text

Class Method Details

.author ⇒ Object 



87
88
89
 
# File 'lib/fastlane/actions/increment_build_number.rb', line 87

def self.author
  "KrauseFx"
end

.available_options ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/fastlane/actions/increment_build_number.rb', line 59

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :build_number,
                                 env_name: "FL_BUILD_NUMBER_BUILD_NUMBER",
                                 description: "Change to a specific version",
                                 optional: true,
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :xcodeproj,
                                 env_name: "FL_BUILD_NUMBER_PROJECT",
                                 description: "optional, you must specify the path to your main Xcode project if it is not in the project root directory",
                                 optional: true,
                                 verify_block: proc do |value|
                                   UI.user_error!("Please pass the path to the project, not the workspace") if value.end_with? ".xcworkspace"
                                   UI.user_error!("Could not find Xcode project") if !File.exist?(value) and !Helper.is_test?
                                 end)
  ]
end

.category ⇒ Object 



105
106
107
 
# File 'lib/fastlane/actions/increment_build_number.rb', line 105

def self.category
  :project
end

.description ⇒ Object 



55
56
57
 
# File 'lib/fastlane/actions/increment_build_number.rb', line 55

def self.description
  "Increment the build number of your project"
end

.example_code ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/fastlane/actions/increment_build_number.rb', line 91

def self.example_code
  [
    'increment_build_number # automatically increment by one',
    'increment_build_number(
      build_number: "75" # set a specific number
    )',
    'increment_build_number(
      build_number: 75, # specify specific build number (optional, omitting it increments by one)
      xcodeproj: "./path/to/MyApp.xcodeproj" # (optional, you must specify the path to your main Xcode project if it is not in the project root directory)
    )',
    'build_number = increment_build_number'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


10
11
12
 
# File 'lib/fastlane/actions/increment_build_number.rb', line 10

def self.is_supported?(platform)
  [:ios, :mac].include? platform
end

.output ⇒ Object 



77
78
79
80
81
 
# File 'lib/fastlane/actions/increment_build_number.rb', line 77

def self.output
  [
    ['BUILD_NUMBER', 'The new build number']
  ]
end

.return_value ⇒ Object 



83
84
85
 
# File 'lib/fastlane/actions/increment_build_number.rb', line 83

def self.return_value
  "The new build number"
end

.run(params) ⇒ Object 



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
 
# File 'lib/fastlane/actions/increment_build_number.rb', line 14

def self.run(params)
  # More information about how to set up your project and how it works:
  # https://developer.apple.com/library/ios/qa/qa1827/_index.html
  # Attention: This is NOT the version number - but the build number

  folder = params[:xcodeproj] ? File.join(params[:xcodeproj], '..') : '.'

  command_prefix = [
    'cd',
    File.expand_path(folder).shellescape,
    '&&'
  ].join(' ')

  command_suffix = [
    '&&',
    'cd',
    '-'
  ].join(' ')

  command = [
    command_prefix,
    'agvtool',
    params[:build_number] ? "new-version -all #{params[:build_number].to_s.strip}" : 'next-version -all',
    command_suffix
  ].join(' ')

  if Helper.test?
    return Actions.lane_context[SharedValues::BUILD_NUMBER] = command
  else
    Actions.sh command

    # Store the new number in the shared hash
    build_number = `#{command_prefix} agvtool what-version`.split("\n").last.strip

    return Actions.lane_context[SharedValues::BUILD_NUMBER] = build_number
  end
rescue => ex
  UI.error('Make sure to follow the steps to setup your Xcode project: https://developer.apple.com/library/ios/qa/qa1827/_index.html')
  raise ex
end