Merge pull request #5 from phoenix-actions/feature/output-enhancements

Feature/output enhancements

.github/workflows/dirty-laundry.yml

@@ -19,6 +19,7 @@ jobs:
 
       - name: Create mochawesome report
         uses: ./
+        id: test-report
         if: success() || failure()
         with:
           name: Mochawesome Tests

README.md

@@ -44,13 +44,48 @@ jobs:
 
       - name: Test Report
         uses: phoenix-actions/test-reporting@v3
+        id: test-report               # Set ID reference for step
         if: success() || failure()    # run this step even if previous step failed
         with:
           name: JEST Tests            # Name of the check run which will be created
           path: reports/jest-*.xml    # Path to test results
           reporter: jest-junit        # Format of test results
 ```
 
+## Action Outputs
+
+A list of the possible action outputs are listed below.
+
+* runHtmlUrl
+
+In case you want to extract and read an output from the action, see the below example code:
+```yaml
+on:
+  pull_request:
+  push:
+jobs:
+  build-test:
+    name: Build & Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2     # checkout the repo
+      - run: npm ci                   # install packages
+      - run: npm test                 # run tests (configured to use jest-junit reporter)
+
+      - name: Test Report
+        uses: phoenix-actions/test-reporting@v3
+        id: test-report               # Set ID reference for step
+        if: success() || failure()    # run this step even if previous step failed
+        with:
+          name: JEST Tests            # Name of the check run which will be created
+          path: reports/jest-*.xml    # Path to test results
+          reporter: jest-junit        # Format of test results
+
+      - name: Read output variables
+        run: |
+          echo "url is ${{ steps.test-report.outputs.runHtmlUrl }}"
+```
+
 ## Recommended setup for public repositories
 
 Workflows triggered by pull requests from forked repositories are executed with read-only token and therefore can't create check runs.
@@ -89,6 +124,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: phoenix-actions/test-reporting@v3
+      id: test-report                     # Set ID reference for step
       with:
         artifact: test-results            # artifact name
         name: JEST Tests                  # Name of the check run which will be created

src/main.ts

@@ -19,6 +19,7 @@ import {MochawesomeJsonParser} from './parsers/mochawesome-json/mochawesome-json
 
 import {normalizeDirPath, normalizeFilePath} from './utils/path-utils'
 import {getCheckRunContext} from './utils/github-utils'
+import {Outputs} from './utils/constants'
 
 async function main(): Promise<void> {
   try {
@@ -197,6 +198,8 @@ class TestReporter {
     core.info(`Check run URL: ${resp.data.url}`)
     core.info(`Check run HTML: ${resp.data.html_url}`)
 
+    core.setOutput(Outputs.runHtmlUrl, `${resp.data.html_url}`)
+
     return results
   }
 

src/utils/constants.ts

@@ -0,0 +1,3 @@
+export enum Outputs {
+  runHtmlUrl = 'runHtmlUrl'
+}