Skip to content

Show ci-summary

show ci-summary - Generate CI workflow summary for a module

The show ci-summary command generates a formatted CI workflow summary with job results. This command is designed to be used in GitHub Actions workflows to create consistent CI summaries. The output is formatted as Markdown and can be redirected to $GITHUB_STEP_SUMMARY.

Flags

Flag Description
--build Build job result (success/failure/skipped)
--container (default: false) Whether this is a container module
--container-test Container test result (for container modules)
--container-test-enabled (default: false) Whether container test was enabled
--test-linux Linux test result (for binary modules)
--test-windows Windows test result (for binary modules)
--test-macos macOS test result (for binary modules)
--test-on-windows (default: false) Whether Windows tests were enabled
--test-on-macos (default: false) Whether macOS tests were enabled
--scan Security scan result
--scans-enabled (default: false) Whether scans were enabled
--evidence Evidence build result
--evidence-enabled (default: false) Whether evidence building was enabled

Notes

Expected Output:

  • Markdown-formatted CI summary with job results table
  • Shows build, test (Linux/Windows/macOS), container test, and scan results
  • Supports both container and binary module types

See Also


Tutorials | How-to Guides | Explanation | Reference

You are here: Reference — information-oriented technical descriptions of the system.