Class: Fastlane::Actions::AndroidSetVersionNameAction

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

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



69
70
71
 
# File 'lib/fastlane/plugin/versioning_android/actions/android_set_version_name.rb', line 69

def self.authors
  ["Igor Lamoš"]
end

.available_options ⇒ Object 



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
 
# File 'lib/fastlane/plugin/versioning_android/actions/android_set_version_name.rb', line 33

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :gradle_file,
                            env_name: "FL_ANDROID_SET_VERSION_NAME_GRADLE_FILE",
                         description: "(optional) Specify the path to your app build.gradle if it isn't in the default location",
                            optional: true,
                                type: String,
                       default_value: "app/build.gradle",
                        verify_block: proc do |value|
                          UI.user_error!("Could not find app build.gradle file") unless File.exist?(value) || Helper.test?
                        end),
    FastlaneCore::ConfigItem.new(key: :version_name,
                            env_name: "FL_ANDROID_SET_VERSION_NAME_VERSION_NAME",
                         description: "(optional) Set specific Version Name",
                            optional: true,
                                type: String,
                       default_value: nil),
    FastlaneCore::ConfigItem.new(key: :bump_type,
                            env_name: "FL_ANDROID_SET_VERSION_NAME_BUMP_TYPE",
                         description: "(optional) Type of version bump (major, minor, patch)",
                            optional: true,
                                type: String,
                       default_value: nil)
  ]
end

.description ⇒ Object 



25
26
27
 
# File 'lib/fastlane/plugin/versioning_android/actions/android_set_version_name.rb', line 25

def self.description
  "Set the Version Name of your Android project"
end

.details ⇒ Object 



29
30
31
 
# File 'lib/fastlane/plugin/versioning_android/actions/android_set_version_name.rb', line 29

def self.details
  "This action will set the new Version Name on your Android project."
end

.example_code ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/fastlane/plugin/versioning_android/actions/android_set_version_name.rb', line 77

def self.example_code
  [
    'android_set_version_name(
      version_name: "2.34.5" # Set a specific number
    )',
    'android_set_version_name(
      version_name: "2.34.5",
      gradle_file: "/path/to/build.gradle" # build.gradle is not in the default location
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


73
74
75
 
# File 'lib/fastlane/plugin/versioning_android/actions/android_set_version_name.rb', line 73

def self.is_supported?(platform)
  [:android].include? platform
end

.output ⇒ Object 



59
60
61
62
63
 
# File 'lib/fastlane/plugin/versioning_android/actions/android_set_version_name.rb', line 59

def self.output
  [
    ['ANDROID_NEW_VERSION_NAME', 'The new Version Name of your Android project']
  ]
end

.return_value ⇒ Object 



65
66
67
 
# File 'lib/fastlane/plugin/versioning_android/actions/android_set_version_name.rb', line 65

def self.return_value
  "The new Version Name of your Android project"
end

.run(params) ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/fastlane/plugin/versioning_android/actions/android_set_version_name.rb', line 8

def self.run(params)
  gradle_file_path = Helper::VersioningAndroidHelper.get_gradle_file_path(params[:gradle_file])
  new_version_name = Helper::VersioningAndroidHelper.get_new_version_name(gradle_file_path, params[:version_name], params[:bump_type])
  # bump_type ||= params[:bump_type]

  saved = Helper::VersioningAndroidHelper.save_key_to_gradle_file(gradle_file_path, "versionName", new_version_name)

  if saved == -1
    UI.user_error!("Unable to set the Version Name in build.gradle file at #{gradle_file_path}.")
  end

  UI.success("☝️  Android Version Name has been set to: #{new_version_name}")

  # Store the versionName in the shared hash
  Actions.lane_context[SharedValues::ANDROID_NEW_VERSION_NAME] = new_version_name
end