Class: Fastlane::Actions::GithubCheckPullMergedAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



121
122
123
 
# File 'lib/fastlane/plugin/github_api/actions/github_check_pull_merged_action.rb', line 121

def authors
  ["crazymanish"]
end

.available_options ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/fastlane/plugin/github_api/actions/github_check_pull_merged_action.rb', line 76

def available_options
  [
    FastlaneCore::ConfigItem.new(key: :api_token,
                         env_name: "GITHUB_API_TOKEN",
                      description: "GitHub API token",
                         optional: false,
                        sensitive: true,
               code_gen_sensitive: true,
                    default_value: ENV["GITHUB_API_TOKEN"],
                     verify_block: proc do |value|
                       UI.user_error!("No GitHub API token given, pass using `api_token: 'token'`") if value.to_s.empty?
                     end),
    FastlaneCore::ConfigItem.new(key: :server_url,
                         env_name: "GITHUB_API_SERVER_URL",
                      description: "GitHub API server URL",
                         optional: true,
                    default_value: "https://api.github.com"),
    FastlaneCore::ConfigItem.new(key: :repo_owner,
                         env_name: "GITHUB_API_REPO_OWNER",
                      description: "Owner of the repository",
                         optional: false),
    FastlaneCore::ConfigItem.new(key: :repo_name,
                         env_name: "GITHUB_API_REPO_NAME",
                      description: "Name of the repository",
                         optional: false),
    FastlaneCore::ConfigItem.new(key: :pull_number,
                         env_name: "GITHUB_API_PULL_NUMBER",
                      description: "The number of the pull request",
                         optional: false,
                             type: Integer)
  ]
end

.description ⇒ Object 



64
65
66
 
# File 'lib/fastlane/plugin/github_api/actions/github_check_pull_merged_action.rb', line 64

def description
  "Check if a pull request has been merged"
end

.details ⇒ Object 



68
69
70
71
72
73
74
 
# File 'lib/fastlane/plugin/github_api/actions/github_check_pull_merged_action.rb', line 68

def details
  [
    "Checks if a pull request has been merged.",
    "You must provide your GitHub Personal token (get one from https://github.com/settings/tokens/new).",
    "API Documentation: https://docs.github.com/en/rest/pulls/pulls#check-if-a-pull-request-has-been-merged"
  ].join("\n")
end

.example_code ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/fastlane/plugin/github_api/actions/github_check_pull_merged_action.rb', line 129

def example_code
  [
    'github_check_pull_merged(
      repo_owner: "octocat",
      repo_name: "Hello-World",
      pull_number: 42
    )',
    'result = github_check_pull_merged(
      repo_owner: "octocat",
      repo_name: "Hello-World",
      pull_number: 42
    )
    
    if result[:is_merged]
      puts "Pull request #42 has been merged!"
    else
      puts "Pull request #42 has not been merged yet."
    end'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


125
126
127
 
# File 'lib/fastlane/plugin/github_api/actions/github_check_pull_merged_action.rb', line 125

def is_supported?(platform)
  true
end

.output ⇒ Object 



109
110
111
112
113
114
115
 
# File 'lib/fastlane/plugin/github_api/actions/github_check_pull_merged_action.rb', line 109

def output
  [
    ['GITHUB_CHECK_PULL_MERGED_STATUS_CODE', 'The status code returned by the GitHub API'],
    ['GITHUB_CHECK_PULL_MERGED_RESPONSE', 'The full response body returned by the GitHub API'],
    ['GITHUB_PULL_IS_MERGED', 'Boolean indicating whether the pull request has been merged']
  ]
end

.return_value ⇒ Object 



117
118
119
 
# File 'lib/fastlane/plugin/github_api/actions/github_check_pull_merged_action.rb', line 117

def return_value
  "Returns a hash containing the status code, response body, and a boolean indicating if the pull request is merged."
end

.run(params) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
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
58
 
# File 'lib/fastlane/plugin/github_api/actions/github_check_pull_merged_action.rb', line 14

def run(params)
  # Prepare API call parameters
  server_url = params[:server_url]
  api_token = params[:api_token]
  repo_owner = params[:repo_owner]
  repo_name = params[:repo_name]
  pull_number = params[:pull_number]
  
  # Build the path
  path = "/repos/#{repo_owner}/#{repo_name}/pulls/#{pull_number}/merge"
  
  UI.message("Checking if pull request ##{pull_number} from #{repo_owner}/#{repo_name} is merged")
  response = Helper::GithubApiHelper.github_api_request(
    token: api_token,
    path: path,
    method: :get,
    server_url: server_url
  )
  
  status_code = response[:status]
  is_merged = status_code == 204
  result = {
    status: status_code,
    body: response[:body],
    is_merged: is_merged
  }
  
  if is_merged
    UI.success("Pull request ##{pull_number} has been merged")
  elsif status_code == 404
    UI.message("Pull request ##{pull_number} has not been merged")
  else
    UI.error("Error checking if pull request is merged: #{status_code}")
    UI.error(response[:body])
    UI.user_error!("GitHub API returned #{status_code}: #{response[:body]}")
    return nil
  end
  
  # Store the results in shared values
  Actions.lane_context[SharedValues::GITHUB_CHECK_PULL_MERGED_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_CHECK_PULL_MERGED_RESPONSE] = response[:body]
  Actions.lane_context[SharedValues::GITHUB_PULL_IS_MERGED] = is_merged
  
  return result
end