📖 [Docs]: build diagnostics and reporting into the GitHub Actions standard#13
Merged
Marius Storhaug (MariusStorhaug) merged 10 commits intoJul 5, 2026
Merged
Conversation
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 3, 2026 17:58
View session
There was a problem hiding this comment.
Pull request overview
This PR updates the GitHub Actions coding standard to add explicit expectations for built-in diagnostics: grouped verbose logging, step-summary receipts, trigger-aware feedback (PR/issue comments), and merge-gating via named status checks.
Changes:
- Extends the GitHub Actions standard with a new “Build in logging and diagnostics” section covering logging, step summaries, reporting channels, and gating checks.
- Updates the GitHub Actions page metadata/description and the Coding Standards index entry to reflect the new “diagnostic logging” guidance.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/docs/Coding-Standards/index.md | Updates the generated index row description for the GitHub Actions standard to include diagnostic logging. |
| src/docs/Coding-Standards/GitHub-Actions.md | Adds a new diagnostics section and updates frontmatter description to include diagnostic logging. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 3, 2026 18:08
View session
…ts; collapsible step summaries
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 4, 2026 08:39
View session
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 4, 2026 08:52
View session
…ons, escaping note, secret-safe logging, jobs wrapper
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 4, 2026 09:05
View session
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 4, 2026 09:19
View session
added 2 commits
July 5, 2026 12:47
…: read to the report job
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 5, 2026 10:59
View session
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 5, 2026 11:05
View session
Copilot started reviewing on behalf of
Marius Storhaug (MariusStorhaug)
July 5, 2026 11:15
View session
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a "Build in logging and diagnostics" section to the GitHub Actions
standard: an action reports on itself so any run is diagnosable from the log it
already produced.
The section states how an action logs, signals its result, and gates a merge.
calls, and outputs are logged on every run, each phase wrapped in a
::group::block so the detail is present yet collapsed.
::notice::/::warning::/::error::carry the lines a reader must not miss — above all the finalresult — with dynamic values escaped.
is GitHub-flavored Markdown in the step summary: the headline in the open, long
detail folded into
<details>blocks, and the same facts exposed as outputs.channel the trigger implies — a pull-request comment, an issue comment, or the
step summary — as one upserted comment from the single job that holds write
scope.
surfaces as a stable, named check that exits non-zero on a real failure.
The examples follow the PSModule action helpers (
LogGroup,Write-GitHubNotice,Set-GitHubStepSummary,Details).Context: extends the standard from authoring mechanics into how an action
communicates its work.