fastlane-plugin-github_api 0.1.0

data/lib/fastlane/plugin/github_api/actions/github_update_issue_comment_action.rb

@@ -0,0 +1,172 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_UPDATE_ISSUE_COMMENT_STATUS_CODE = :GITHUB_UPDATE_ISSUE_COMMENT_STATUS_CODE
+      GITHUB_UPDATE_ISSUE_COMMENT_RESPONSE = :GITHUB_UPDATE_ISSUE_COMMENT_RESPONSE
+      GITHUB_UPDATE_ISSUE_COMMENT_JSON = :GITHUB_UPDATE_ISSUE_COMMENT_JSON
+    end
+
+    class GithubUpdateIssueCommentAction < Action
+      class << self
+        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]
+          comment_id = params[:comment_id]
+          body = params[:body]
+          
+          # Validate parameters
+          UI.user_error!("No comment ID provided, pass using `comment_id: 12345678`") unless comment_id.to_s.length > 0
+          UI.user_error!("No comment body provided, pass using `body: 'Updated comment'`") if body.to_s.empty?
+          
+          # Build the path
+          path = "/repos/#{repo_owner}/#{repo_name}/issues/comments/#{comment_id}"
+          
+          # Build body parameters
+          body_params = {
+            body: body
+          }
+          
+          UI.message("Updating comment ID: #{comment_id} in #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: api_token,
+            path: path,
+            params: body_params,
+            method: :patch,
+            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)
+            UI.success("Successfully updated comment ID: #{comment_id} in #{repo_owner}/#{repo_name}")
+          else
+            UI.error("Error updating comment: #{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_UPDATE_ISSUE_COMMENT_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_UPDATE_ISSUE_COMMENT_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_UPDATE_ISSUE_COMMENT_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "Updates a comment on a GitHub issue"
+        end
+        
+        def details
+          [
+            "Updates an existing comment on an issue in a GitHub repository.",
+            "You must provide your GitHub Personal token (get one from https://github.com/settings/tokens/new).",
+            "API Documentation: https://docs.github.com/en/rest/issues/comments#update-an-issue-comment"
+          ].join("\n")
+        end
+        
+        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: "Repository owner (organization or username)",
+                                 optional: false,
+                                     type: String),
+            FastlaneCore::ConfigItem.new(key: :repo_name,
+                                 env_name: "GITHUB_API_REPO_NAME",
+                              description: "Repository name",
+                                 optional: false,
+                                     type: String),
+            FastlaneCore::ConfigItem.new(key: :comment_id,
+                              description: "The ID of the comment to update",
+                                 optional: false,
+                                     type: Integer),
+            FastlaneCore::ConfigItem.new(key: :body,
+                              description: "The updated body text of the comment",
+                                 optional: false,
+                                     type: String)
+          ]
+        end
+        
+        def output
+          [
+            ['GITHUB_UPDATE_ISSUE_COMMENT_STATUS_CODE', 'The status code returned from the GitHub API'],
+            ['GITHUB_UPDATE_ISSUE_COMMENT_RESPONSE', 'The full response body from the GitHub API'],
+            ['GITHUB_UPDATE_ISSUE_COMMENT_JSON', 'The parsed JSON returned from the GitHub API']
+          ]
+        end
+        
+        def return_value
+          "A hash including the HTTP status code (:status), the response body (:body), and the parsed JSON (:json)."
+        end
+        
+        def authors
+          ["crazymanish"]
+        end
+        
+        def example_code
+          [
+            'github_update_issue_comment(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              comment_id: 12345678,
+              body: "Updated comment text"
+            )',
+            '# You can also access the response data
+            result = github_update_issue_comment(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              comment_id: 12345678,
+              body: "Updated comment text"
+            )
+            UI.message("Updated comment by: #{result[:json]["user"]["login"]}")'
+          ]
+        end
+        
+        def category
+          :source_control
+        end
+        
+        def is_supported?(platform)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/github_api/actions/github_update_label_action.rb

@@ -0,0 +1,204 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_UPDATE_LABEL_RESPONSE = :GITHUB_UPDATE_LABEL_RESPONSE
+      GITHUB_UPDATE_LABEL_JSON = :GITHUB_UPDATE_LABEL_JSON
+      GITHUB_UPDATE_LABEL_STATUS_CODE = :GITHUB_UPDATE_LABEL_STATUS_CODE
+    end
+
+    class GithubUpdateLabelAction < Action
+      class << self
+        def run(params)
+          token = params[:api_token]
+          repo_owner = params[:repo_owner]
+          repo_name = params[:repo_name]
+          label_name = params[:name]
+          server_url = params[:server_url]
+          
+          # Validate parameters (additional validation beyond what's in ConfigItem)
+          UI.user_error!("No label name provided, pass using `name: 'bug'`") if label_name.to_s.empty?
+          
+          # Prepare request parameters
+          # URL encode the label name to handle special characters like spaces, etc.
+          encoded_label = URI.encode_www_form_component(label_name)
+          path = "/repos/#{repo_owner}/#{repo_name}/labels/#{encoded_label}"
+          
+          # Build body parameters
+          body_params = {}
+          body_params[:new_name] = params[:new_name] if params[:new_name]
+          
+          if params[:color]
+            body_params[:color] = params[:color].start_with?('#') ? params[:color][1..-1] : params[:color]
+          end
+          
+          body_params[:description] = params[:description] if params[:description]
+          
+          # Make the request
+          UI.message("Updating label '#{label_name}' in #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: token,
+            path: path,
+            params: body_params,
+            method: :patch,
+            server_url: server_url
+          )
+          
+          status_code = response.key?('status') ? response['status'] : nil
+          result = {
+            status: status_code,
+            body: response,
+            json: response
+          }
+          
+          if response.key?('error')
+            UI.error("GitHub responded with an error: #{response['error']}")
+            UI.user_error!("GitHub API error: #{response['error']}")
+            return nil
+          end
+          
+          if response['message'] && status_code && status_code >= 400
+            UI.error("GitHub API error: #{response['message']}")
+            UI.user_error!("GitHub API error: #{response['message']} (Status code: #{status_code})")
+            return nil
+          end
+          
+          new_name = params[:new_name] || label_name
+          UI.success("Successfully updated label '#{new_name}' in #{repo_owner}/#{repo_name}")
+          
+          # Set the shared values
+          Actions.lane_context[SharedValues::GITHUB_UPDATE_LABEL_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_UPDATE_LABEL_RESPONSE] = response
+          Actions.lane_context[SharedValues::GITHUB_UPDATE_LABEL_JSON] = response
+          
+          return result
+        end
+
+        #####################################################
+        # @!group Documentation
+        #####################################################
+
+        def description
+          "Updates a label in a GitHub repository"
+        end
+
+        def details
+          [
+            "This action updates an existing label in a GitHub repository, allowing changes to its name, color, and description.",
+            "It requires a valid GitHub API token with appropriate permissions.",
+            "Documentation: [https://docs.github.com/en/rest/issues/labels](https://docs.github.com/en/rest/issues/labels#update-a-label)"
+          ].join("\n")
+        end
+
+        def available_options
+          [
+            FastlaneCore::ConfigItem.new(key: :api_token,
+                                    env_name: "GITHUB_API_TOKEN",
+                                 description: "GitHub API token with repo permissions",
+                                    optional: false,
+                                        type: String,
+                                   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: "Repository owner (organization or username)",
+                                    optional: false,
+                                        type: String,
+                               verify_block: proc do |value|
+                                  UI.user_error!("No repository owner provided, pass using `repo_owner: 'owner'`") if value.to_s.empty?
+                                end),
+            FastlaneCore::ConfigItem.new(key: :repo_name,
+                                 env_name: "GITHUB_API_REPO_NAME",
+                                 description: "Repository name",
+                                    optional: false,
+                                        type: String,
+                               verify_block: proc do |value|
+                                  UI.user_error!("No repository name provided, pass using `repo_name: 'name'`") if value.to_s.empty?
+                                end),
+            FastlaneCore::ConfigItem.new(key: :name,
+                                 description: "The current name of the label",
+                                    optional: false,
+                                        type: String,
+                               verify_block: proc do |value|
+                                  UI.user_error!("No label name provided, pass using `name: 'bug'`") if value.to_s.empty?
+                                end),
+            FastlaneCore::ConfigItem.new(key: :new_name,
+                                 description: "The new name for the label",
+                                    optional: true,
+                                        type: String),
+            FastlaneCore::ConfigItem.new(key: :color,
+                                 description: "The color of the label in hexadecimal format (with or without leading #)",
+                                    optional: true,
+                                        type: String,
+                                 verify_block: proc do |value|
+                                   value = value[1..-1] if value.start_with?('#')
+                                   UI.user_error!("Color must be a valid 6 character hex code") unless value.match?(/^[0-9A-Fa-f]{6}$/)
+                                 end),
+            FastlaneCore::ConfigItem.new(key: :description,
+                                 description: "A short description of the label",
+                                    optional: true,
+                                        type: String)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_UPDATE_LABEL_STATUS_CODE', 'The status code returned from the GitHub API'],
+            ['GITHUB_UPDATE_LABEL_RESPONSE', 'The full response from the GitHub API'],
+            ['GITHUB_UPDATE_LABEL_JSON', 'The JSON data returned from the GitHub API']
+          ]
+        end
+
+        def return_value
+          "A hash including the HTTP status code (:status), the response body (:body), and the parsed JSON (:json)."
+        end
+
+        def authors
+          ["crazymanish"]
+        end
+
+        def example_code
+          [
+            'github_update_label(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              name: "bug",
+              new_name: "confirmed-bug",
+              color: "b60205",
+              description: "Confirmed bugs that need to be fixed"
+            )',
+            '# You can also access the response data
+            result = github_update_label(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              name: "enhancement",
+              color: "a2eeef"
+            )
+            UI.message("Updated label color: #{result[:json]["color"]}")'
+          ]
+        end
+
+        def category
+          :source_control
+        end
+
+        def is_supported?(platform)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/github_api/actions/github_update_milestone_action.rb

@@ -0,0 +1,198 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_UPDATE_MILESTONE_RESPONSE = :GITHUB_UPDATE_MILESTONE_RESPONSE
+      GITHUB_UPDATE_MILESTONE_JSON = :GITHUB_UPDATE_MILESTONE_JSON
+      GITHUB_UPDATE_MILESTONE_STATUS_CODE = :GITHUB_UPDATE_MILESTONE_STATUS_CODE
+    end
+
+    class GithubUpdateMilestoneAction < Action
+      class << self
+        def run(params)
+          token = params[:api_token]
+          repo_owner = params[:repo_owner]
+          repo_name = params[:repo_name]
+          milestone_number = params[:milestone_number]
+          server_url = params[:server_url]
+          
+          # Validate parameters (additional validation beyond what's in ConfigItem)
+          UI.user_error!("No GitHub milestone number given, pass using `milestone_number: 42`") unless milestone_number.to_s.length > 0
+          
+          # Prepare request parameters
+          path = "/repos/#{repo_owner}/#{repo_name}/milestones/#{milestone_number}"
+          
+          # Build body parameters
+          body_params = {}
+          body_params[:title] = params[:title] if params[:title]
+          body_params[:state] = params[:state] if params[:state]
+          body_params[:description] = params[:description] if params[:description]
+          body_params[:due_on] = params[:due_on] if params[:due_on]
+          
+          # Make the request
+          UI.message("Updating milestone ##{milestone_number} in #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: token,
+            path: path,
+            params: body_params,
+            method: :patch,
+            server_url: server_url
+          )
+          
+          status_code = response.key?('status') ? response['status'] : nil
+          result = {
+            status: status_code,
+            body: response,
+            json: response
+          }
+          
+          if response.key?('error')
+            UI.error("GitHub responded with an error: #{response['error']}")
+            UI.user_error!("GitHub API error: #{response['error']}")
+            return nil
+          end
+          
+          if response['message'] && status_code && status_code >= 400
+            UI.error("GitHub API error: #{response['message']}")
+            UI.user_error!("GitHub API error: #{response['message']} (Status code: #{status_code})")
+            return nil
+          end
+          
+          UI.success("Successfully updated milestone ##{milestone_number} - #{response['title']} in #{repo_owner}/#{repo_name}")
+          
+          # Set the shared values
+          Actions.lane_context[SharedValues::GITHUB_UPDATE_MILESTONE_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_UPDATE_MILESTONE_RESPONSE] = response
+          Actions.lane_context[SharedValues::GITHUB_UPDATE_MILESTONE_JSON] = response
+          
+          return result
+        end
+
+        #####################################################
+        # @!group Documentation
+        #####################################################
+
+        def description
+          "Updates an existing milestone in a GitHub repository"
+        end
+
+        def details
+          [
+            "This action updates an existing milestone in a GitHub repository with the specified parameters.",
+            "It requires a valid GitHub API token with appropriate permissions.",
+            "Documentation: [https://docs.github.com/en/rest/issues/milestones](https://docs.github.com/en/rest/issues/milestones#update-a-milestone)"
+          ].join("\n")
+        end
+
+        def available_options
+          [
+            FastlaneCore::ConfigItem.new(key: :api_token,
+                                    env_name: "GITHUB_API_TOKEN",
+                                 description: "GitHub API token with repo permissions",
+                                    optional: false,
+                                        type: String,
+                                   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: "Repository owner (organization or username)",
+                                    optional: false,
+                                        type: String,
+                               verify_block: proc do |value|
+                                  UI.user_error!("No repository owner provided, pass using `repo_owner: 'owner'`") if value.to_s.empty?
+                                end),
+            FastlaneCore::ConfigItem.new(key: :repo_name,
+                                 env_name: "GITHUB_API_REPO_NAME",
+                                 description: "Repository name",
+                                    optional: false,
+                                        type: String,
+                               verify_block: proc do |value|
+                                  UI.user_error!("No repository name provided, pass using `repo_name: 'name'`") if value.to_s.empty?
+                                end),
+            FastlaneCore::ConfigItem.new(key: :milestone_number,
+                                 description: "The milestone number to update",
+                                    optional: false,
+                                        type: Integer),
+            FastlaneCore::ConfigItem.new(key: :title,
+                                 description: "The title of the milestone",
+                                    optional: true,
+                                        type: String),
+            FastlaneCore::ConfigItem.new(key: :state,
+                                 description: "The state of the milestone (open or closed)",
+                                    optional: true,
+                                        type: String,
+                                 verify_block: proc do |value|
+                                   UI.user_error!("State must be 'open' or 'closed'") unless ['open', 'closed'].include?(value)
+                                 end),
+            FastlaneCore::ConfigItem.new(key: :description,
+                                 description: "A description of the milestone",
+                                    optional: true,
+                                        type: String),
+            FastlaneCore::ConfigItem.new(key: :due_on,
+                                 description: "The milestone due date in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)",
+                                    optional: true,
+                                        type: String)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_UPDATE_MILESTONE_STATUS_CODE', 'The status code returned from the GitHub API'],
+            ['GITHUB_UPDATE_MILESTONE_RESPONSE', 'The full response from the GitHub API'],
+            ['GITHUB_UPDATE_MILESTONE_JSON', 'The JSON data returned from the GitHub API']
+          ]
+        end
+
+        def return_value
+          "A hash including the HTTP status code (:status), the response body (:body), and the parsed JSON (:json)."
+        end
+
+        def authors
+          ["crazymanish"]
+        end
+
+        def example_code
+          [
+            'github_update_milestone(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              milestone_number: 42,
+              title: "v1.1",
+              state: "closed",
+              description: "First minor update"
+            )',
+            '# You can also access the response data
+            result = github_update_milestone(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              milestone_number: 42,
+              state: "closed"
+            )
+            UI.message("Updated milestone title: #{result[:json]["title"]}")'
+          ]
+        end
+
+        def category
+          :source_control
+        end
+
+        def is_supported?(platform)
+          true
+        end
+      end
+    end
+  end
+end