GitHub Status API Integration

Commits are marked with [success/error] state depending on offence detection. If there are any offences in the code, the commit is marked with error state otherwise with success state. It is reflected at the end of PR in the check conclusion part.

app/workers/commit_monitor_handlers/commit_range/rubocop_checker.rb

@@ -34,12 +34,19 @@ def process_branch
   end
 
   def rubocop_comments
-    MessageBuilder.new(results, branch).comments
+    message_builder = MessageBuilder.new(results, branch)
+
+    {
+      :status   => message_builder.commit_status,
+      :comments => message_builder.comments
+    }
   end
 
   def replace_rubocop_comments
     logger.info("Updating PR #{pr_number} with rubocop comment.")
-    GithubService.replace_comments(fq_repo_name, pr_number, rubocop_comments) do |old_comment|
+    msg_builder_result = rubocop_comments
+
+    GithubService.replace_comments(fq_repo_name, pr_number, msg_builder_result[:comments], msg_builder_result[:status]) do |old_comment|
       rubocop_comment?(old_comment)
     end
   end

app/workers/commit_monitor_handlers/commit_range/rubocop_checker/message_builder.rb

@@ -14,6 +14,20 @@ def comments
     message_builder.comments
   end
 
+  # requirements to "create_status(repo, sha, state, options)"
+  def commit_status
+    {
+      "repo"    => fq_repo_name,
+      "sha"     => commits.last,
+      "state"   => files.empty? ? "success" : "error",
+      "options" => {
+        "context"     => "miq-bot", # TODO: it should be user name variable
+        "target_url"  => nil,
+        "description" => files.empty? ? "Everything looks fine." : "Something went wrong."
+      }
+    }
+  end
+
   private
 
   attr_reader :results, :message_builder

lib/github_service.rb

@@ -12,8 +12,17 @@ module GithubService
   #
   class << self
     def add_comments(fq_repo_name, issue_number, comments)
-      Array(comments).each do |comment|
+      # add_status requires first comment due to its URL
+      Array(comments).map do |comment|
         add_comment(fq_repo_name, issue_number, comment)
+      end.first
+    end
+
+    # https://octokit.github.io/octokit.rb/Octokit/Client/Statuses.html#create_status-instance_method
+    def add_status(comstat, comment)
+      unless comstat.nil?
+        comstat["options"]["target_url"] = comment["html_url"]
+        create_status(comstat["repo"], comstat["sha"], comstat["state"], comstat["options"])
       end
     end
 
@@ -25,12 +34,15 @@ def delete_comments(fq_repo_name, comment_ids)
 
     # Deletes the issue comments found by the provided block, then creates new
     # issue comments from those provided.
-    def replace_comments(fq_repo_name, issue_number, new_comments)
+    def replace_comments(fq_repo_name, issue_number, new_comments, commit_status = nil)
       raise "no block given" unless block_given?
 
       to_delete = issue_comments(fq_repo_name, issue_number).select { |c| yield c }
       delete_comments(fq_repo_name, to_delete.map(&:id))
-      add_comments(fq_repo_name, issue_number, new_comments)
+      first_comment = add_comments(fq_repo_name, issue_number, new_comments)
+
+      # add_status creates a commit status pointing to the first comment URL
+      add_status(commit_status, first_comment)
     end
 
     def issue(*args)