Class: Fastlane::Actions::GithubListPullCommitsAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



140
141
142
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_pull_commits_action.rb', line 140

def authors
  ["crazymanish"]
end

.available_options ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_pull_commits_action.rb', line 85

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),
    FastlaneCore::ConfigItem.new(key: :per_page,
                         env_name: "GITHUB_API_PER_PAGE",
                      description: "Results per page (max 100)",
                         optional: true,
                             type: Integer),
    FastlaneCore::ConfigItem.new(key: :page,
                         env_name: "GITHUB_API_PAGE",
                      description: "Page number of the results to fetch",
                         optional: true,
                             type: Integer)
  ]
end

.description ⇒ Object 



73
74
75
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_pull_commits_action.rb', line 73

def description
  "Lists commits on a pull request"
end

.details ⇒ Object 



77
78
79
80
81
82
83
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_pull_commits_action.rb', line 77

def details
  [
    "Lists commits on a pull request by its number.",
    "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#list-commits-on-a-pull-request"
  ].join("\n")
end

.example_code ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_pull_commits_action.rb', line 148

def example_code
  [
    'github_list_pull_commits(
      repo_owner: "octocat",
      repo_name: "Hello-World",
      pull_number: 42
    )',
    'pull_commits = github_list_pull_commits(
      repo_owner: "octocat",
      repo_name: "Hello-World",
      pull_number: 42,
      per_page: 30,
      page: 1
    )
    
    commits = pull_commits[:json]
    commits.each do |commit|
      puts "Commit SHA: #{commit["sha"]}"
      puts "Author: #{commit["commit"]["author"]["name"]}"
      puts "Message: #{commit["commit"]["message"]}"
      puts "---"
    end'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


144
145
146
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_pull_commits_action.rb', line 144

def is_supported?(platform)
  true
end

.output ⇒ Object 



128
129
130
131
132
133
134
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_pull_commits_action.rb', line 128

def output
  [
    ['GITHUB_LIST_PULL_COMMITS_STATUS_CODE', 'The status code returned by the GitHub API'],
    ['GITHUB_LIST_PULL_COMMITS_RESPONSE', 'The full response body returned by the GitHub API'],
    ['GITHUB_LIST_PULL_COMMITS_JSON', 'The parsed JSON response returned by the GitHub API']
  ]
end

.return_value ⇒ Object 



136
137
138
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_pull_commits_action.rb', line 136

def return_value
  "Returns a hash containing the status code, response body, and parsed JSON response from the GitHub API."
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
59
60
61
62
63
64
65
66
67
 
# File 'lib/fastlane/plugin/github_api/actions/github_list_pull_commits_action.rb', line 14

def run(params)
  require 'json'
  
  # 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]
  per_page = params[:per_page]
  page = params[:page]
  
  # Build query parameters
  query_params = {}
  query_params[:per_page] = per_page if per_page
  query_params[:page] = page if page
  
  # Build the path
  path = "/repos/#{repo_owner}/#{repo_name}/pulls/#{pull_number}/commits"
  
  UI.message("Getting commits for pull request ##{pull_number} from #{repo_owner}/#{repo_name}")
  response = Helper::GithubApiHelper.github_api_request(
    token: api_token,
    path: path,
    params: query_params.empty? ? nil : query_params,
    method: :get,
    server_url: server_url
  )
  
  status_code = response[:status]
  json_response = response[:json]
  result = {
    status: status_code,
    body: response[:body],
    json: json_response
  }
  
  if status_code.between?(200, 299)
    commit_count = json_response.is_a?(Array) ? json_response.count : 0
    UI.success("Successfully retrieved #{commit_count} commits for pull request ##{pull_number} from #{repo_owner}/#{repo_name}")
  else
    UI.error("Error getting pull request commits: #{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_LIST_PULL_COMMITS_STATUS_CODE] = status_code
  Actions.lane_context[SharedValues::GITHUB_LIST_PULL_COMMITS_RESPONSE] = response[:body]
  Actions.lane_context[SharedValues::GITHUB_LIST_PULL_COMMITS_JSON] = json_response
  
  return result
end