https://github.com/michaelhenry/create-report

A Github action for creating generic run report (using Markdown, HTML or JUnit).
https://github.com/michaelhenry/create-report

checks-api ci ci-report github-action github-run-checks html junit markdown reports

Last synced: 6 months ago
JSON representation

A Github action for creating generic run report (using Markdown, HTML or JUnit).

• Host: GitHub
• URL: https://github.com/michaelhenry/create-report
• Owner: michaelhenry
• License: mit
• Created: 2021-12-12T13:43:15.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-03-07T15:06:07.000Z (over 3 years ago)
• Last Synced: 2024-05-02T01:36:53.614Z (about 2 years ago)
• Topics: checks-api, ci, ci-report, github-action, github-run-checks, html, junit, markdown, reports
• Language: Swift
• Homepage:
• Size: 49.8 KB
• Stars: 3
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# create-report

[![codecov](https://codecov.io/gh/michaelhenry/create-report/branch/main/graph/badge.svg?token=TC3XYJYG61)](https://codecov.io/gh/michaelhenry/create-report)

[![codebeat badge](https://codebeat.co/badges/f52c2068-17ca-41a1-8421-f6b54e4155d4)](https://codebeat.co/projects/github-com-michaelhenry-create-report-main) [![Test Coverage](https://api.codeclimate.com/v1/badges/20de4a63612d960d1bf1/test_coverage)](https://codeclimate.com/github/michaelhenry/create-report/test_coverage) [![Maintainability](https://api.codeclimate.com/v1/badges/20de4a63612d960d1bf1/maintainability)](https://codeclimate.com/github/michaelhenry/create-report/maintainability)

A Github action for creating generic run report. Currently this action is supporting 3 data format: `markdown`, `html` or `junit`.

Sample workflow:

```yml

jobs:

  create-report:

    name: Report using ${{ matrix.os }}

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v2

    - uses: michaelhenry/create-report@v2.0.0

      name: create report from a junit file.

      with:

        title: "JUnit report"

        path: samples/sample.junit

        format: junit

```

## Using Markdown

```yml

  - uses: michaelhenry/create-report@v2

    name: create report from markdown

    with:

      title: "Markdown report"

      path: samples/sample.md

      format: markdown

```

Please see [samples/sample.md](samples/sample.md) for the sample file which generated this run report.



---

## Using HTML

```yml

  - uses: michaelhenry/create-report@v2

    name: create report from html

    with:

      title: "HTML report"

      path: samples/sample.html

      format: html

```

Please see [samples/sample.html](samples/sample.html) for the sample file which generated this run report.



---

## Using JUnit

```yml

  - uses: michaelhenry/create-report@v2

    name: create report from junit

    with:

      title: "JUnit report"

      path: samples/sample.junit

      format: junit

```

Please see [samples/sample.junit](samples/sample.junit) for the sample file which generated this run report.



---