Merge pull request #11 from mikepenz/feature/improve_log_output

Improved GitHub Actions logging

.github/workflows/build.yml

@@ -12,13 +12,15 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v2
-      - uses: mikepenz/action-junit-report-2@main
+      - name: Test JUnit test import
+        uses: ./
         if: endsWith(github.ref, 'main') == false
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           check_name: Example JUnit Test Report
           report_paths: '**/surefire-reports/TEST-*.xml'
-      - uses: mikepenz/action-junit-report-2@main
+      - name: Test PyTest test import
+        uses: ./
         if: endsWith(github.ref, 'main') == false
         with:
           token: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -9,6 +9,10 @@
     ... reports JUnit test results as GitHub pull request check.
 </p>
 
+<div align="center">
+  <img src=".github/images/action.png"/>
+</div>
+
 <div align="center">
   <a href="https://github.com/mikepenz/action-junit-report">
 		<img src="https://github.com/mikepenz/action-junit-report/workflows/CI/badge.svg"/>
@@ -22,7 +26,7 @@
 
 This action processes JUnit XML test reports on pull requests and shows the result as a PR check with summary and annotations.
 
-If you are looking for surefire reporting check out the amazing plugin by [ScaCap - action-surefire-report](https://github.com/ScaCap/action-surefire-report)
+Based on action for [Surefire Reports by ScaCap](https://github.com/ScaCap/action-surefire-report)
 
 ### Inputs
 
@@ -59,7 +63,13 @@ jobs:
 
 ## Sample
 
-![Screenshot](./screenshot.png)
+<div align="center">
+  <img src=".github/images/annotated.png"/>
+</div>
+
+<div align="center">
+  <img src=".github/images/annotations.png"/>
+</div>
 
 ## Contribute
 

__tests__/testParser.test.ts

@@ -1,5 +1,13 @@
 import { resolveFileAndLine, resolvePath, parseFile } from '../src/testParser'
 
+/**
+ * Original test cases:
+ *   Copyright 2020 ScaCap
+ *   https://github.com/ScaCap/action-surefire-report/blob/master/utils.test.js
+ * 
+ * New test cases:
+ *   Copyright Mike Penz
+ */
 describe('resolveFileAndLine', () => {
     it('should default to 1 if no line found', async () => {
         const { fileName, line } = await resolveFileAndLine(null, 'someClassName', 'not a stacktrace');

src/main.ts

@@ -18,7 +18,7 @@ export async function run(): Promise<void> {
     const failOnFailure = core.getInput('fail_on_failure') === 'true'
 
     core.endGroup()
-    core.startGroup(`📘 Process test results`)
+    core.startGroup(`📦 Process test results`)
 
     const testResult = await parseTestReports(reportPaths)
     const foundResults = testResult.count > 0 || testResult.skipped > 0
@@ -56,7 +56,7 @@ export async function run(): Promise<void> {
     core.debug(JSON.stringify(createCheckRequest, null, 2))
     core.endGroup()
 
-    core.startGroup(`📘 Publish results`)
+    core.startGroup(`🚀 Publish results`)
 
     try {
       const octokit = new Octokit({

src/testParser.ts

@@ -26,6 +26,10 @@ export interface Position {
   line: number
 }
 
+/**
+ * Copyright 2020 ScaCap
+ * https://github.com/ScaCap/action-surefire-report/blob/master/utils.js#L6
+ */
 export async function resolveFileAndLine(
   file: string | null,
   className: string,
@@ -42,6 +46,10 @@ export async function resolveFileAndLine(
   return {fileName, line: parseInt(line)}
 }
 
+/**
+ * Copyright 2020 ScaCap
+ * https://github.com/ScaCap/action-surefire-report/blob/master/utils.js#L18
+ */
 export async function resolvePath(fileName: string): Promise<string> {
   core.debug(`Resolving path for ${fileName}`)
   const globber = await glob.create(`**/${fileName}.*`, {
@@ -59,6 +67,10 @@ export async function resolvePath(fileName: string): Promise<string> {
   return fileName
 }
 
+/**
+ * Copyright 2020 ScaCap
+ * https://github.com/ScaCap/action-surefire-report/blob/master/utils.js#L43
+ */
 export async function parseFile(file: string): Promise<TestResult> {
   core.debug(`Parsing file ${file}`)
   let count = 0
@@ -137,6 +149,10 @@ export async function parseFile(file: string): Promise<TestResult> {
   return {count, skipped, annotations}
 }
 
+/**
+ * Copyright 2020 ScaCap
+ * https://github.com/ScaCap/action-surefire-report/blob/master/utils.js#L113
+ */
 export async function parseTestReports(
   reportPaths: string
 ): Promise<TestResult> {