Skip to content

Show approve-summary

show approve-summary - Generate release approval summary

The show approve-summary command generates a formatted release approval summary. This command is designed to be used in GitHub Actions workflows to create consistent approval summaries. The output is formatted as Markdown and can be redirected to $GITHUB_STEP_SUMMARY.

Flags

Flag Description
--module Module name (required)
--version Release version (required)
--tag Full tag name (required)
--commit Commit SHA (required)
--version-type (default: semver) Version type (semver or calver)
--ci-skipped (default: false) Whether CI check was skipped
--status (default: success) Overall status (success or failure)
--run-id Run ID for diagnostic links on failure

Notes

Expected Output:

  • Markdown-formatted approval summary with check status table
  • Shows version, tag, commit, changelog, existing release, and CI check status
  • On failure, can output diagnostic link via pipeline ci summary-link

See Also


Tutorials | How-to Guides | Explanation | Reference

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