Some Docu

rename field to report_name

CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 
+## v1.2.0
+
+- Added the coverage percent to result title on Check [#4](https://github.com/devmasx/coverage-check-action/pull/4)
+
+## v1.1.0
+
+- Lcov
+
 ## v1.0.0
 
 - Create check run in github
-- Adapter for brakeman report
+- Simplecov

README.md

@@ -2,28 +2,43 @@
 
 A GitHub Action that check minimum coverage percentage!
 
+This action requires a Github token with `checks:write` scope to allow create the check run using the Github API v3.
+But no need to generate any new token, you can use the Github action token (`${{ github.token }}`)
+
 ### Usage
 
 #### Lcov
 
 ```yml
-- uses: devmasx/coverage-check-action@v1.1.0
+- uses: devmasx/coverage-check-action@v1.2.0
   with:
     type: lcov
     result_path: coverage/example.lcov
     min_coverage: 90
-    token: ${{secrets.GITHUB_TOKEN}}
+    token: ${{ github.token }}
 ```
 
 #### [Simplecov](https://github.com/colszowka/simplecov)
 
 ```yml
-- uses: devmasx/coverage-check-action@v1.1.0
+- uses: devmasx/coverage-check-action@v1.2.0
   with:
     type: simplecov
     result_path: coverage/.last_run.json
     min_coverage: 90
-    token: ${{secrets.GITHUB_TOKEN}}
+    token: ${{ github.token }}
+```
+
+#### Report name
+
+```yml
+- uses: devmasx/coverage-check-action@v1.2.0
+  with:
+    type: lcov
+    result_path: coverage/example.lcov
+    min_coverage: 90
+    token: ${{ github.token }}
+    report_name: "My Github Action Check Name"
 ```
 
 ## Screenshots

action.yml

@@ -12,10 +12,12 @@ inputs:
   token:
     description: "Github token for create checks"
     required: true
-    default: "World"
   min_coverage:
     description: "Minimum coverage"
     default: "80"
+  report_name:
+    description: "Name of the github action check"
+    default: "Coverage"
   result_path:
     description: "Json with coverage result"
     required: true

lib/github_check_run_service.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
 class GithubCheckRunService
-  CHECK_NAME = 'Coverage'
+  def initialize(report, github_data, report_name, report_adapter)
-
-  def initialize(report, github_data, report_adapter)
     @report = report
     @github_data = github_data
+    @report_name = report_name
     @report_adapter = report_adapter
     @client = GithubClient.new(@github_data[:token], user_agent: 'coverage-action')
   end
@@ -18,6 +17,7 @@ class GithubCheckRunService
     @summary = @report_adapter.summary(@report)
     @annotations = @report_adapter.annotations(@report)
     @conclusion = @report_adapter.conslusion(@report)
+    @percent = @report_adapter.lines_covered_percent(@report)
 
     @client.patch(
       "#{endpoint_url}/#{id}",
@@ -33,7 +33,7 @@ class GithubCheckRunService
 
   def create_check_payload
     {
-      name: CHECK_NAME,
+      name: @report_name,
       head_sha: @github_data[:sha],
       status: 'in_progress',
       started_at: Time.now.iso8601
@@ -42,13 +42,13 @@ class GithubCheckRunService
 
   def update_check_payload
     {
-      name: CHECK_NAME,
+      name: @report_name,
       head_sha: @github_data[:sha],
       status: 'completed',
       completed_at: Time.now.iso8601,
       conclusion: @conclusion,
       output: {
-        title: CHECK_NAME,
+        title: "#{@report_name} #{@percent}%",
         summary: @summary,
         annotations: @annotations
       }

lib/index.rb

@@ -17,13 +17,14 @@ end
   sha: ENV['GITHUB_SHA'],
   token: ENV['INPUT_TOKEN'],
   owner: ENV['GITHUB_REPOSITORY_OWNER'] || @event_json.dig('repository', 'owner', 'login'),
-  repo: ENV['GITHUB_REPOSITORY_NAME'] || @event_json.dig('repository', 'name')
+  repo: ENV['GITHUB_REPOSITORY_NAME'] || @event_json.dig('repository', 'name'),
 }
 
 @coverage_type = ENV['INPUT_TYPE']
 @report_path = ENV['INPUT_RESULT_PATH']
+@report_name = ENV['INPUT_REPORT_NAME']
 @data = { min: ENV['INPUT_MIN_COVERAGE'] }
 
 @report = CoverageReport.generate(@coverage_type, @report_path, @data)
 
-GithubCheckRunService.new(@report, @github_data, ReportAdapter).run
+GithubCheckRunService.new(@report, @github_data, @report_name, ReportAdapter).run

lib/report_adapter.rb

@@ -18,16 +18,16 @@ class ReportAdapter
       []
     end
 
+    def lines_covered_percent(report)
+      @lines_covered_percent ||= report.dig('lines', 'covered_percent')
+    end
+
     private
 
     def table_head
       "| Type  | covered | minimum |\n| ----- | ------- | ------- |"
     end
 
-    def lines_covered_percent(report)
-      @lines_covered_percent ||= report.dig('lines', 'covered_percent')
-    end
-
     def lines_minimum_percent(report)
       @lines_minimum_percent ||= report.dig('lines', 'minumum_percent')
     end

spec/github_check_run_service_spec.rb

@@ -7,7 +7,8 @@ describe GithubCheckRunService do
     { 'lines' => { 'covered_percent' => 80, 'minumum_percent' => 80 } }
   end
   let(:github_data) { { sha: 'sha', token: 'token', owner: 'owner', repo: 'repository_name' } }
-  let(:service) { GithubCheckRunService.new(report, github_data, ReportAdapter) }
+  let(:report_name) { 'Coverage' }
+  let(:service) { GithubCheckRunService.new(report, github_data, report_name, ReportAdapter) }
 
   it '#run' do
     stub_request(:any, 'https://api.github.com/repos/owner/repository_name/check-runs/id')