markdown-to-summary-action

A GitHub action to post a markdown file to a action summary check.

Features

• Can work from files in workspace
• Can work with files from artifacts
• Can work with raw markdown string
• Control on conclusion of the check
• Control on the name of the check
• Already on node20

Important

Artifact support is via v4 artifacts only

Usage

# file version

- name: markdown-to-summary-action
  id: md
  uses: mediatech15/markdown-to-summary-action@v1.1
  with:
    file: 'md.md'
    check_name: md
    conclusion: success

# artifact version

- name: markdown-to-summary-action
  id: md2
  uses: mediatech15/markdown-to-summary-action@v1.1
  with:
    file: 'files/markdown.md'
    artifact: test-artifact
    check_name: md-artifact
    conclusion: neutral

# raw string version

- name: markdown-to-summary-action
  id: md3
  uses: mediatech15/markdown-to-summary-action@v1.1
  with:
    markdown: '# Hello'
    check_name: md-raw
    conclusion: neutral

Inputs Explained

name	default	about
file	empty	the file to use. if artifact mode it is the path to file within artifact
markdown	empty	the markdown string to use
artifact	empty	the name of the artifact to pull
check_name	filename	the name of the check to show in the run. defaults to the files name
conclusion	success	the outcome of the check. can be success, failure, action_required, neutral

Multiple files/checks?

Tip

Run the action multiple times

Permissions

• checks: write
• actions: read

Screenshots

License

The scripts and documentation in this project are released under the MIT License