Skip to main content

Simple github action summary report for robotframework

Project description

robotframework-ghareports

This project enables robot framework to generate Github Job Summary for a testrun. Its a simple robot framework listener, that once activated when RF is executed, it checks if environment variable GITHUB_STEP_SUMMARY exists and if it does, it exposes test results to a PR - example output looks something like this

Usage

Install:

python -mpip install robotframework-ghareports

Usage:

robot --listener GHAReports .

If you want to limit the width of the tables in the summary, you can provide an argument to the listener like this:

robot --listener GHAReports:35 .

This will split each test case name at every 35 characters into a new line.

And if you want to generate the summary even if a) you are not running in Github or you want to generate extra summary file independent of Github actions, pass report_file argument to the listener like this:

robot --listener GHAReports:report_file=extra_summary.md

or

robot --listener GHAReports:34:extra_summary.md

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

robotframework_ghareports-0.3.1-py3-none-any.whl (18.0 kB view details)

Uploaded Python 3

File details

Details for the file robotframework_ghareports-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for robotframework_ghareports-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c4c795f705aa0db4808beab741bde5a74da94c47145b7b95f382621b555af0a4
MD5 f4cea6f161059373693d9c6a9aad6d54
BLAKE2b-256 34dad051f8e95d71fd420b10fd36dacb0ad8b75179ed046547076821d3dc9d42

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page