Skip to content
book-open

GitHub Action

tasty-json-to-markdown

v2.0.6 Latest version

tasty-json-to-markdown

book-open

tasty-json-to-markdown

GitHub action which takes JSON output by tasty-json and produces a markdown table with the results of the tests

Installation

Copy and paste the following snippet into your .yml file.

              

- name: tasty-json-to-markdown

uses: ConnorBaker/tasty-json-to-markdown-action@v2.0.6

Learn more about this action in ConnorBaker/tasty-json-to-markdown-action

Choose a version

Markdown tables built from tasty-json

This action creates a Markdown table from the JSON output by tasty-json and displays it as a job summary1.

It takes at least one argument, tasty_json_filepath, which is the path to the JSON file produced by tasty-json.

Optionally, it takes a second argument: markdown_filepath, the path where you'd like to store the produced Markdown file. This argument can be omitted, in which case the action will only write the resulting Markdown to the job summary.

As an example of what it does, check out the sample input JSON ./tests/resources/rest_rewrite_test_tasty.json and the resulting Markdown table ./tests/resources/expected.md. You can see an example of the job summary output by viewing the results of this action's build-test workflow. The data used is from a run of the rest library.

Footnotes

  1. https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/