Skip to content

Latest commit

 

History

History
44 lines (34 loc) · 1.33 KB

README.md

File metadata and controls

44 lines (34 loc) · 1.33 KB
Raw

Generate job summary from Nox report

If you use Nox to test or otherwise handle your project in an Actions workflow, this action can create a job summary for you, based on the JSON report generated by Nox.

The summary might look like this:

Nox

  • lint: success ✔️
  • typecheck: success ✔️
  • test-3.9: skipped 🔵
  • test-3.10: success ✔️
  • test-3.11: skipped 🔵
  • coverage: success ✔️

Each Nox session is listed with its status and a matching symbol.

Usage example

- name: Set up Nox
  uses: wntrblm/[email protected]
- name: Run Nox
  run: |
    nox --report test-report.json
- name: Create job summary
  uses: airtower-luna/[email protected]
  with:
    report: test-report.json

This action requires the python binary to be a Python 3 interpreter. Using any of the actions/setup-python or wntrblm/nox (which calls actions/setup-python in turn) actions before this one is sufficient.

Arguments

  • report: The report file you want to use, as generated by nox --report FILE.json

  • title: The title you want the summary to have, defaults to "Nox".