Class: Fastlane::Actions::HgPushAction

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

Overview

Pushes commits to the remote hg repo

Constant Summary

Constants inherited from Fastlane::Action

Fastlane::Action::AVAILABLE_CATEGORIES, Fastlane::Action::RETURN_TYPES

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, authors, deprecated_notes, lane_context, method_missing, other_action, output, return_type, return_value, sample_return_value, shell_out_should_use_bundle_exec?, step_text

Class Method Details

.authorObject


40
41
42
43
# File 'fastlane/lib/fastlane/actions/hg_push.rb', line 40

def self.author
  # credits to lmirosevic for original git version
  "sjrmanning"
end

.available_optionsObject


25
26
27
28
29
30
31
32
33
34
35
36
37
38
# File 'fastlane/lib/fastlane/actions/hg_push.rb', line 25

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :force,
                                 env_name: "FL_HG_PUSH_FORCE",
                                 description: "Force push to remote",
                                 is_string: false,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :destination,
                                 env_name: "FL_HG_PUSH_DESTINATION",
                                 description: "The destination to push to",
                                 default_value: '',
                                 optional: true)
  ]
end

.categoryObject


59
60
61
# File 'fastlane/lib/fastlane/actions/hg_push.rb', line 59

def self.category
  :source_control
end

.descriptionObject


17
18
19
# File 'fastlane/lib/fastlane/actions/hg_push.rb', line 17

def self.description
  "This will push changes to the remote hg repository"
end

.detailsObject


21
22
23
# File 'fastlane/lib/fastlane/actions/hg_push.rb', line 21

def self.details
  "The mercurial equivalent of [push_to_git_remote](https://docs.fastlane.tools/actions/push_to_git_remote/). Pushes your local commits to a remote mercurial repo. Useful when local changes such as adding a version bump commit or adding a tag are part of your lane’s actions."
end

.example_codeObject


49
50
51
52
53
54
55
56
57
# File 'fastlane/lib/fastlane/actions/hg_push.rb', line 49

def self.example_code
  [
    'hg_push',
    'hg_push(
      destination: "ssh://[email protected]/owner/repo",
      force: true
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:


45
46
47
# File 'fastlane/lib/fastlane/actions/hg_push.rb', line 45

def self.is_supported?(platform)
  true
end

.run(params) ⇒ Object


5
6
7
8
9
10
11
12
13
14
15
# File 'fastlane/lib/fastlane/actions/hg_push.rb', line 5

def self.run(params)
  command = ['hg', 'push']

  command << '--force' if params[:force]
  command << params[:destination] unless params[:destination].empty?

  return command.join(' ') if Helper.test?

  Actions.sh(command.join(' '))
  UI.success('Successfully pushed changes to remote 🚀.')
end