Merge pull request #78 from ctrf-io/feat/commit-report

Feat/commit report #77 #75

Author: Ma11hewThomas

.github/workflows/commit-action.yaml

@@ -0,0 +1,36 @@
+name: commit-action-example
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  testing:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install dependencies
+        run: npm install
+      - name: Build
+        run: npm run all:action
+      - name: Publish Test Report
+        uses: ./
+        with:
+          report-path: './ctrf/*.json'
+          commit-report: true
+        if: always()
+      - name: Upload test results
+        uses: actions/upload-artifact@v4
+        with:
+          name: ctrf-report
+          path: ctrf-reports/ctrf-report.json
+      - name: Upload test results
+        uses: actions/upload-artifact@v4
+        with:
+          name: custom-artifact-name
+          path: ctrf-reports/ctrf-report-no-fails.json

README.md

@@ -113,6 +113,7 @@ There are several inputs available
     suite-folded-report: false
     suite-list-report: false
     pull-request-report: false
+    commit-report: false
     custom-report: false
 
     # Behavior Options

action.yml

@@ -78,6 +78,10 @@ inputs:
     description: 'Include the pull request report.'
     required: false
     default: false
+  commit-report:
+    description: 'Include the commit report.'
+    required: false
+    default: false
   custom-report:
     description: >
       Include a custom report using a Handlebars template. To group tests in the

badges/coverage.svg

@@ -19,6 +19,7 @@ execution.
   - [Skipped Report](#skipped-report)
   - [Suite Folded Report](#suite-folded-report)
   - [Suite List Report](#suite-list-report)
+  - [Commit Report](#commit-report)
   - [Pull Request Report](#pull-request-report)
 
 ## Summary Report
@@ -671,6 +672,39 @@ Set the `suite-list-report` input to true in your workflow configuration:
 - **✅ stripAnsi handles empty strings correctly**
 - **✅ stripAnsi throws a TypeError if the input is not a string**
 
+## Commit Report
+
+### Overview
+
+Provides a detailed summary of test results and associated commits for an
+execution. It helps teams trace test outcomes back to specific changes in the
+codebase
+
+### Usage
+
+Set the `commit-report` input to true in your workflow configuration:
+
+```yaml
+- name: Publish Test Report
+  uses: ctrf-io/github-test-reporter@v1
+  with:
+    report-path: './ctrf/*.json'
+    commit-report: true
+  if: always()
+```
+
+---
+
+<p><strong>14 passed</strong>, <strong>0 failed</strong>, and <strong>0 other</strong></p>
+
+| Timestamp         | **Hash**                                                                                                              | **Author**     | Message       |
+| ----------------- | --------------------------------------------------------------------------------------------------------------------- | -------------- | ------------- |
+| Jan 19, 25, 16:49 | [2eac572](https://github.com/Ma11hewThomas/github-test-reporter-test/commit/2eac57223c6fc070f8657076b2c578363b01f601) | @Ma11hewThomas | third commit  |
+| Jan 19, 25, 16:48 | [2ed8310](https://github.com/Ma11hewThomas/github-test-reporter-test/commit/2ed831054406356c12ea1520de632a04ca23bb3e) | @Ma11hewThomas | second commit |
+| Jan 19, 25, 16:48 | [23c693e](https://github.com/Ma11hewThomas/github-test-reporter-test/commit/23c693ebfbf42c5526f8d0b8744414c2aa4a8cc6) | @Ma11hewThomas | first commit  |
+
+[Compare before f9aecf1 and after 2eac572](https://github.com/Ma11hewThomas/github-test-reporter-test/compare/f9aecf1b04ed...2eac57223c6f)
+
 ## Pull Request Report
 
 ### Overview

dist/index.js

@@ -25,6 +25,7 @@ export function getCliInputs(args: Arguments): Inputs {
     suiteFoldedReport: args._.includes('suite-folded'),
     suiteListReport: args._.includes('suite-list'),
     pullRequestReport: args._.includes('pull-request'),
+    commitReport: args._.includes('commit'),
     customReport: args._.includes('custom'),
     communityReport: args._.includes('community'),
     communityReportName: args.communityReportName || '',
@@ -76,6 +77,8 @@ export function getInputs(): Inputs {
       core.getInput('suite-list-report').toLowerCase() === 'true',
     pullRequestReport:
       core.getInput('pull-request-report').toLowerCase() === 'true',
+    commitReport: core.getInput('commit-report').toLowerCase() === 'true',
+
     customReport: core.getInput('custom-report').toLowerCase() === 'true',
     communityReport: core.getInput('community-report').toLowerCase() === 'true',
     communityReportName: core.getInput('community-report-name'),

dist/index.js.map

@@ -33,6 +33,7 @@ export function generateViews(inputs: Inputs, report: CtrfReport): void {
     inputs.suiteFoldedReport ||
     inputs.suiteListReport ||
     inputs.pullRequestReport ||
+    inputs.commitReport ||
     inputs.customReport ||
     inputs.communityReport
 
@@ -89,6 +90,10 @@ export function generateViews(inputs: Inputs, report: CtrfReport): void {
     addViewToSummary('', BuiltInReports.PullRequest, report)
   }
 
+  if (inputs.commitReport) {
+    addViewToSummary('### Commits', BuiltInReports.CommitTable, report)
+  }
+
   if (inputs.customReport && inputs.templatePath) {
     const customTemplate = readTemplate(inputs.templatePath)
     const customMarkdown = generateMarkdown(customTemplate, report)