seges-dist

dist/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+Copyright (c) 2022 Edward Thomson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+OR OTHER DEALINGS IN THE SOFTWARE.
+

dist/README.md

@@ -0,0 +1,158 @@
+Test Summary
+============
+![Test dashboard: 42 tests passed](https://svg.test-summary.com/dashboard.svg?p=42)
+![Test dashboard: 42 tests failed](https://svg.test-summary.com/dashboard.svg?f=42)
+![Test dashboard: 42 tests passed, 8 tests failed, 18 tests skipped](https://svg.test-summary.com/dashboard.svg?p=42&f=8&s=18)
+
+Produce an easy-to-read summary of your project's test data as part of your GitHub Actions CI/CD workflow. This helps you understand at-a-glance the impact to the changes in your pull requests, and see which changes are introducing new problems.
+
+* Integrates easily with your existing GitHub Actions workflow
+* Produces summaries from JUnit XML and TAP test output
+* Compatible with most testing tools for most development platforms
+* Produces step outputs, so you can pass summary data to other actions
+* Customizable to show just a summary, just failed tests, or all test results
+* Output can go to the [GitHub job summary](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary) (default), to a file or `stdout`
+
+Getting Started
+---------------
+To set up the test summary action, just add a few lines of YAML to your GitHub Actions workflow. For example, if your test harness produces JUnit XML outputs in the `test/results/` directory, and you want the output attached to the job summary, add a new step to your workflow YAML after your build and test step:
+
+```yaml
+- name: Test Summary
+  uses: test-summary/action@v2
+  with:
+    paths: "test/results/**/TEST-*.xml"
+  if: always()
+```
+
+Update `paths` to match the test output file(s) that your test harness produces. You can specify glob patterns, including `**` to match the pattern recursively. In addition, you can specify multiple test paths on multiple lines. For example:
+
+```yaml
+- name: Test Summary
+  uses: test-summary/action@v2
+  with:
+    paths: |
+      test-one/**/TEST-*.xml
+      test-two/results/results.tap
+  if: always()
+```
+
+> Note the `if: always()` conditional in this workflow step: you should always use this so that the test summary creation step runs _even if_ the previous steps have failed. This allows your test step to fail -- due to failing tests -- but still produce a test summary.
+
+Generating and uploading a markdown file
+----------------------------------------
+You can also generate the summary in a GitHub-flavored Markdown (GFM) file, and upload it as a build artifact, add it to a pull request comment, or add it to an issue. Use the `output` parameter to define the target file.
+
+For example, to create a summary and upload the markdown as a build artifact:
+
+```yaml
+- name: Test Summary
+  uses: test-summary/action@v2
+  with:
+    paths: "test/results/**/TEST-*.xml"
+    output: test-summary.md
+  if: always()
+
+- name: Upload test summary
+  uses: actions/upload-artifact@v3
+  with:
+    name: test-summary
+    path: test-summary.md
+  if: always()
+```
+
+Outputs
+-------
+This action also generates several outputs you can reference in other steps, or even from your job or workflow. These outputs are `passed`, `failed`, `skipped`, and `total`.
+
+For example, you may want to send a summary to Slack:
+
+```yaml
+- name: Test Summary
+  id: test_summary
+  uses: test-summary/action@v2
+  with:
+    paths: "test/results/**/TEST-*.xml"
+  if: always()
+- name: Notify Slack
+  uses: slackapi/[email protected]
+  with:
+    payload: |-
+      {
+        "message": "${{ steps.test_summary.outputs.passed }}/${{ steps.test_summary.outputs.total }} tests passed"
+      }
+  if: always()
+```
+
+Examples
+--------
+There are examples for setting up a GitHub Actions step with many different platforms [in the examples repository](https://github.com/test-summary/examples).
+
+Options
+-------
+Options are specified on the [`with` map](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswith) of the action.
+
+* **`paths`: the paths for input files** (required)  
+  One or more file [glob patterns](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet) that specify the test results files in JUnit XML or TAP format.
+
+  * To specify a single file, provide it directly as a string value to the `paths` key. For example:
+
+    ```yaml
+    - uses: test-summary/action@v2
+      with:
+        paths: "tests/results.xml"
+    ```
+
+  * To specify multiple files, provide them as a multi-line string value to the `paths` key. For example:
+
+    ```yaml
+    - uses: test-summary/action@v2
+      with:
+        paths: |
+          tests-one/results.xml
+          tests-two/results.xml
+          tests-three/results.xml
+    ```
+
+  * You can specify files as a [glob patterns](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet), allowing you to use wildcards to match multiple files. For example, to match all files named `TEST-*.xml` beneath the `tests` folder, recursively:
+
+    ```yaml
+    - uses: test-summary/action@v2
+      with:
+        paths: "test/results/**/TEST-*.xml"
+    ```
+
+* **`output`: the output file to create** (optional)  
+  This is the path to the output file to populate with the test summary markdown data. For example:
+
+  ```yaml
+  - uses: test-summary/action@v2
+    with:
+      paths: "test/results/**/TEST-*.xml"
+      output: "test/results/summary.md"
+  ```
+
+  If this is not specified, the output will be to the workflow summary.
+
+  This file is [GitHub Flavored Markdown (GFM)](https://github.github.com/gfm/) and may include permitted HTML.
+
+* **`show`: the test results to summarize in a table** (optional)
+  This controls whether a test summary table is created or not, as well as what tests are included. It could be `all`, `none`, `pass`, `skip`, or `fail`. The default is `fail` - that is, the summary table will only show the failed tests. For example, if you wanted to show failed and skipped tests:
+
+  ```yaml
+  - uses: test-summary/action@v2
+    with:
+      paths: "test/results/**/TEST-*.xml"
+      show: "fail, skip"
+  ```
+
+FAQ
+---
+* **How is the summary graphic generated? Does any of my data ever leave GitHub?**  
+  None of your data ever leaves GitHub. Test results are read within GitHub Actions by the test-summary action, and a link to an SVG with the test results numbers is created. This the graphic is both fetched and subsequently cached by GitHub's image service. This service provides no referral information to remote hosts. This means that no information at all about your workflow - the repository name, test results, or other information - is available to the image generator service.
+
+Questions / Help / Contact
+--------------------------
+Have questions? Need help? Visit [the discussion forum](https://github.com/test-summary/action/discussions).
+
+Copyright (c) 2022 Edward Thomson. Available under the MIT license.

dist/action.yml

@@ -0,0 +1,17 @@
+name: 'TestForest Dashboard'
+description: 'Display test results summary in a GitHub Actions workflow'
+author: 'Edward Thomson'
+inputs:
+  paths:
+    description: Path(s) to test output file(s) to analyze
+    required: true
+  output:
+    description: File to write with rendered output
+  show:
+    description: Types of tests to show in the results table
+runs:
+  using: 'node16'
+  main: 'index.js'
+branding:
+  icon: check-square
+  color: green