-
Notifications
You must be signed in to change notification settings - Fork 0
Use Step Summary for release information instead of notices #273
Copy link
Copy link
Open
Labels
Description
Context
The Process-PSModule workflow posts release information using GitHub Actions notices. Notices are useful for inline messages but are not well-suited for structured release reports that span multiple registries.
Request
Release information should be displayed using GitHub Actions Step Summary instead of notices. Step Summary provides a more structured and visually appealing output directly on the workflow run page.
What is expected
The workflow should produce a Step Summary with:
- A clear Release Report header
- A table showing releases across registries:
| Registry | Status | Version | Link |
|---|---|---|---|
| GitHub | ✅ Published | v1.0.0 | Release |
| PowerShell Gallery | ✅ Published | 1.0.0 | Package |
- Release notes displayed below the table
Acceptance criteria
- Release information is rendered as a Step Summary on the workflow run page
- The summary includes a table with registry name, status, version, and link
- Release notes are displayed in the summary
- The summary is extensible for future registries (NuGet, Azure Artifacts, etc.)
- Failed or skipped publishes are indicated with appropriate status icons
Technical decisions
To be determined during implementation planning.
Implementation plan
- Identify where release notices are currently generated in the workflow
- Replace notice output with
$GITHUB_STEP_SUMMARYmarkdown content - Design the release report table format with registry, status, version, and link columns
- Include release notes section below the table
- Handle conditional rows based on which registries were actually published to
- Add error/skip status indicators for failed publishes
- Test with both single-registry and multi-registry publish scenarios
Reactions are currently unavailable