Class: Fastlane::Actions::ReserveGitBuildNumberAction

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

Class Method Summary collapse

Class Method Details

.authorsObject



22
23
24
# File 'lib/fastlane/plugin/git_build_versioning/actions/reserve_git_build_number_action.rb', line 22

def self.authors
  ["Mikko Välimäki"]
end

.available_optionsObject



35
36
37
38
39
40
41
42
43
# File 'lib/fastlane/plugin/git_build_versioning/actions/reserve_git_build_number_action.rb', line 35

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :tag_prefix,
                            env_name: "GIT_BUILD_VERSIONING_TAG_PREFIX",
                         description: "A prefix to be used with tag names",
                            optional: true,
                                type: String)
  ]
end

.descriptionObject



12
13
14
# File 'lib/fastlane/plugin/git_build_versioning/actions/reserve_git_build_number_action.rb', line 12

def self.description
  "Use git for tagging your builds for unique distributed sequential build numbers"
end

.detailsObject



30
31
32
33
# File 'lib/fastlane/plugin/git_build_versioning/actions/reserve_git_build_number_action.rb', line 30

def self.details
  <<-DETAILS
  DETAILS
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean)


45
46
47
48
49
50
51
# File 'lib/fastlane/plugin/git_build_versioning/actions/reserve_git_build_number_action.rb', line 45

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

.outputObject



16
17
18
19
20
# File 'lib/fastlane/plugin/git_build_versioning/actions/reserve_git_build_number_action.rb', line 16

def self.output
  [
    ['GIT_BUILD_NUMBER', 'The build number from git']
  ]
end

.return_valueObject



26
27
28
# File 'lib/fastlane/plugin/git_build_versioning/actions/reserve_git_build_number_action.rb', line 26

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

.run(params) ⇒ Object



7
8
9
10
# File 'lib/fastlane/plugin/git_build_versioning/actions/reserve_git_build_number_action.rb', line 7

def self.run(params)
  tag_prefix = (params[:tag_prefix] || 'build/')
  Helper::GitBuildVersioningHelper.reserve_build_number(tag_prefix)
end