Skip to content

Use Step Summary for release information instead of notices #273

@MariusStorhaug

Description

@MariusStorhaug

Summary

Replace the current notice-based approach for posting release information with GitHub Actions Step Summary for better visibility and formatting.

Description

Currently, release information is posted using GitHub Actions notices. This should be enhanced to use Step Summary, which provides a more structured and visually appealing output.

Proposed Format

The Step Summary should include:

Title

A clear header indicating this is a Release Report

Releases Table

A table showing the releases created across different registries:

Registry Status Version Link
GitHub ✅ Published v1.0.0 Release
PowerShell Gallery ✅ Published 1.0.0 Package
Other registries 🔜 Planned - -

Release Notes

The release notes should be displayed below the table for easy reference.

Benefits

  • Better readability in the workflow summary
  • Structured table format for multiple registries
  • Consolidated view of all release information
  • Extensible for future registry support (NuGet, etc.)

Future Considerations

  • Support for additional registries beyond GitHub and PowerShell Gallery
  • Conditional display based on which registries were actually published to
  • Error status indicators for failed publishes

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions