https://github.com/alan-null/cobertura-to-markdown

https://github.com/alan-null/cobertura-to-markdown

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/alan-null/cobertura-to-markdown
• Owner: alan-null
• License: mit
• Created: 2025-01-25T14:49:23.000Z (4 months ago)
• Default Branch: master
• Last Pushed: 2025-01-25T17:00:28.000Z (4 months ago)
• Last Synced: 2025-02-04T02:15:13.982Z (4 months ago)
• Language: Shell
• Size: 1.95 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cobertura to Markdown Generator

A GitHub Action that generates Markdown reports from a Cobertura `coverage.xml` file using [Pycobertura](https://pypi.org/project/pycobertura/).

## How to use

### Inputs

- `coverage_file` (required): Path to the `coverage.xml` file.

- `output_file` (optional): Path to save the generated Markdown file (default: `output.md`).

**Example Usage**

```yaml

jobs:

  generate-markdown:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout Code

        uses: actions/checkout@v4

      - name: Generate Markdown

        uses: alan-null/cobertura-to-markdown@v1

        with:

          coverage_file: "path/to/coverage.xml"

          output_file: "path/to/output.md"