diff --git a/README.md b/README.md index 862cb8f..5790446 100644 --- a/README.md +++ b/README.md @@ -27,17 +27,17 @@ jobs: 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) + - 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: dorny/test-reporter@v1 - if: always() # run this step even if previous step failed + if: always() # 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 report - reporter: 'jest-junit' # Format of test report + name: 'JEST Tests' # Name of the check run which will be created + path: 'reports/jest-*.xml' # Path to test report + reporter: 'jest-junit' # Format of test report ``` ## Usage @@ -61,7 +61,7 @@ jobs: # jest-junit reporter: '' - # Enables code annotations with error message and stack trace + # Enables code annotations with error message and stack trace captured during test execution annotations: 'true' # Set action as failed if test report contain any failed test @@ -162,7 +162,7 @@ You can use following example configuration in `package.json`: "jest-junit": "^12.0.0" }, "jest-junit": { - "outputDirectory": "__reports__", + "outputDirectory": "reports", "outputName": "jest-junit.xml", "ancestorSeparator": " › ", "uniqueOutputName": "false", @@ -175,6 +175,9 @@ You can use following example configuration in `package.json`: Configuration of `uniqueOutputName`, `suiteNameTemplate`, `classNameTemplate`, `titleTemplate` is important for proper visualization of test results. +## See also +- [paths-filter](https://github.com/dorny/paths-filter) - Conditionally run actions based on files modified by PR, feature branch or pushed commits + ## License The scripts and documentation in this project are released under the [MIT License](https://github.com/dorny/test-reporter/blob/master/LICENSE) diff --git a/action.yml b/action.yml index 9a4c3f9..2995c49 100644 --- a/action.yml +++ b/action.yml @@ -42,3 +42,6 @@ outputs: runs: using: 'node12' main: 'dist/index.js' +branding: + color: blue + icon: file-text