https://github.com/dtinth/markdown-report-action

Attachs some Markdown report to the GitHub Actions build
https://github.com/dtinth/markdown-report-action

Last synced: 29 days ago
JSON representation

Attachs some Markdown report to the GitHub Actions build

• Host: GitHub
• URL: https://github.com/dtinth/markdown-report-action
• Owner: dtinth
• Created: 2021-11-27T06:33:01.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-11-27T07:30:49.000Z (over 3 years ago)
• Last Synced: 2025-03-07T23:47:14.169Z (about 1 month ago)
• Size: 11.7 KB
• Stars: 8
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• project-awesome - dtinth/markdown-report-action - Attachs some Markdown report to the GitHub Actions build (Others)

README

        
# markdown-report-action

Attachs a Markdown report your GitHub Actions build. This action uses the Checks API, which is less noisy and more tidy than using comments.

[This report will appear as another job in GitHub Actions UI:](https://github.com/dtinth/markdown-report-action/runs/4339917802?check_suite_focus=true)

> ![run](https://user-images.githubusercontent.com/193136/143671955-586c13d6-c505-4b10-aab9-6f9343f02ebe.png)

[In a pull request, the report will appear as neutral status check:](https://github.com/dtinth/markdown-report-action/pull/1/checks?check_run_id=4339917802)

> ![checks](https://user-images.githubusercontent.com/193136/143671954-776ea75c-f369-4677-9b7e-d5c8918b9b5d.png)

## Usage

```yaml

# First, create a Markdown file containing the report.

- run: echo 'Content here. You *can* use Markdown.' | tee /tmp/report.md

# Then use this action to generate the report.

- uses: dtinth/markdown-report-action@v1

  with:

    name: Report name

    title: Report title here

    body-file: /tmp/report.md

```