class Fastlane::Actions::GetVersionNumberFromPlistAction

Public Class Methods

authors() click to toggle source
# File lib/fastlane/plugin/versioning/actions/get_version_number_from_plist.rb, line 79
def self.authors
  ["SiarheiFedartsou", "jdouglas-nz"]
end
available_options() click to toggle source
# File lib/fastlane/plugin/versioning/actions/get_version_number_from_plist.rb, line 39
def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :xcodeproj,
                       env_name: "FL_VERSION_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 at path '#{File.expand_path(value)}'") if !File.exist?(value) and !Helper.is_test?
                       end),
    FastlaneCore::ConfigItem.new(key: :target,
                       env_name: "FL_VERSION_NUMBER_TARGET",
                       optional: true,
                       conflicting_options: [:scheme],
                       description: "Specify a specific target if you have multiple per project, optional"),
    FastlaneCore::ConfigItem.new(key: :scheme,
                       env_name: "FL_VERSION_NUMBER_SCHEME",
                       optional: true,
                       conflicting_options: [:target],
                       description: "Specify a specific scheme if you have multiple per project, optional"),
    FastlaneCore::ConfigItem.new(key: :build_configuration_name,
                       optional: true,
                       description: "Specify a specific build configuration if you have different Info.plist build settings for each configuration"),
    FastlaneCore::ConfigItem.new(key: :plist_build_setting_support,
                       description: "support automatic resolution of build setting from xcodeproj if not a literal value in the plist",
                       is_string: false,
                       default_value: false),
    FastlaneCore::ConfigItem.new(key: :skip_package_dependencies_resolution,
                       description: "Skips resolution of Swift Package Manager dependencies",
                       type: Boolean,
                       default_value: false)
  ]
end
description() click to toggle source

@!group Documentation

# File lib/fastlane/plugin/versioning/actions/get_version_number_from_plist.rb, line 28
def self.description
  "Get the version number of your project"
end
details() click to toggle source
# File lib/fastlane/plugin/versioning/actions/get_version_number_from_plist.rb, line 32
def self.details
  [
    "This action will return the current version number set on your project's Info.plist.",
    "note that you can pass plist_build_setting_support: true, in which case it will return from your xcodeproj."
  ].join(' ')
end
is_supported?(platform) click to toggle source
# File lib/fastlane/plugin/versioning/actions/get_version_number_from_plist.rb, line 83
def self.is_supported?(platform)
  %i[ios mac].include? platform
end
output() click to toggle source
# File lib/fastlane/plugin/versioning/actions/get_version_number_from_plist.rb, line 73
def self.output
  [
    ['VERSION_NUMBER', 'The version number']
  ]
end
run(params) click to toggle source
# File lib/fastlane/plugin/versioning/actions/get_version_number_from_plist.rb, line 4
def self.run(params)
  if Helper.test?
    plist = "/tmp/fastlane/tests/fastlane/plist/Info.plist"
  else
    plist = GetInfoPlistPathAction.run(params)
  end

  if params[:plist_build_setting_support]
    UI.important "version will originate from xcodeproj"
    version_number = GetVersionNumberFromXcodeprojAction.run(params)
  else
    UI.important "version will originate from plist."
    version_number = GetInfoPlistValueAction.run(path: plist, key: 'CFBundleShortVersionString')
  end

  # Store the number in the shared hash
  Actions.lane_context[SharedValues::VERSION_NUMBER] = version_number
  version_number
end