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:
- 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.
- name: Set up Nox
uses: wntrblm/nox@2022.8.7
- name: Run Nox
run: |
nox --report test-report.json
- name: Create job summary
uses: airtower-luna/nox-report-to-job-summary@v1.0.0
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.
-
report
: The report file you want to use, as generated bynox --report FILE.json
-
title
: The title you want the summary to have, defaults to "Nox".