Class: Fastlane::Actions::FlutterVersionToolkitAction

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

Class Method Summary collapse

Class Method Details

.authorsObject



18
19
20
# File 'lib/fastlane/plugin/flutter_version_toolkit/actions/flutter_version_toolkit_action.rb', line 18

def self.authors
  ["Sanni Prasad"]
end

.available_optionsObject



31
32
33
34
35
36
37
38
39
40
41
42
# File 'lib/fastlane/plugin/flutter_version_toolkit/actions/flutter_version_toolkit_action.rb', line 31

def self.available_options
  [
    FastlaneCore::ConfigItem.new(
      key: :pubspec_location,
      env_name: 'PUBSPEC_LOCATION',
      description: 'The location of pubspec.yml',
      optional: true,
      type: String,
      default_value: '../pubspec.yaml'
    ),
  ]
end

.descriptionObject



14
15
16
# File 'lib/fastlane/plugin/flutter_version_toolkit/actions/flutter_version_toolkit_action.rb', line 14

def self.description
  "A tool that help get version name and number from pubspec.yaml file in a flutter project"
end

.detailsObject



26
27
28
29
# File 'lib/fastlane/plugin/flutter_version_toolkit/actions/flutter_version_toolkit_action.rb', line 26

def self.details
  # Optional:
  "Hello world"
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean)


44
45
46
47
48
49
50
# File 'lib/fastlane/plugin/flutter_version_toolkit/actions/flutter_version_toolkit_action.rb', line 44

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, :mac, :android].include?(platform)
  true
end

.return_valueObject



22
23
24
# File 'lib/fastlane/plugin/flutter_version_toolkit/actions/flutter_version_toolkit_action.rb', line 22

def self.return_value
  "Returns a VersionInfo object with version name and build number, "
end

.run(params) ⇒ Object



7
8
9
10
11
12
# File 'lib/fastlane/plugin/flutter_version_toolkit/actions/flutter_version_toolkit_action.rb', line 7

def self.run(params)
  version_info = Fastlane::FlutterVersionToolkit.read_version_from_pubspec
  UI.user_error!("Could not retrieve version info from pubspec.yaml") if version_info.nil?
  UI.message("Version Info: #{version_info.version_name} (build #{version_info.build_number})")
  return version_info
end