chore: update otlp.md with xml docs#33468
Conversation
|
@copilot Recompile workflow |
|
✅ PR Code Quality Reviewer completed the code quality review. |
|
🧠 Matt Pocock Skills Reviewer has completed the skills-based review. ✅ |
|
🧪 Test Quality Sentinel completed test quality analysis. No test files were added or modified in this PR (only documentation changes to .github/workflows/shared/otlp.md). Test Quality Sentinel analysis skipped. |
|
✅ smoke-ci: safeoutputs CLI comment + comment-memory run (26144012594)
|
Comment MemoryNote This comment is managed by comment memory.It stores persistent context for this thread in the code block at the top of this comment.
|
There was a problem hiding this comment.
Pull request overview
This PR prevents the “Required secrets” documentation in the shared otlp.md import from being included in the runtime-imported prompt content by wrapping that section in an HTML/XML comment block.
Changes:
- Wrapped the “Required secrets” section in
<!-- ... -->so it’s stripped during prompt generation/sanitization. - Keeps the YAML front matter OTLP configuration unchanged while hiding human docs from the prompt.
Show a summary per file
| File | Description |
|---|---|
| .github/workflows/shared/otlp.md | Wraps the post-front-matter docs section in an XML/HTML comment to prevent prompt leakage. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 0
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Summary
This is a clean, focused fix with no issues.
What was reviewed:
- Documentation section wrapped in HTML comments to prevent leakage into workflow prompts
- Frontmatter configuration unchanged
- Documentation preserved for human readers
Assessment:
✅ Correct approach - HTML comments are the right solution
✅ No impact on functional configuration
✅ Maintains documentation accessibility on GitHub
✅ No correctness, maintainability, or style concerns
Verdict: APPROVE - ready to merge.
🔎 Code quality review by PR Code Quality Reviewer · ● 1.4M
There was a problem hiding this comment.
Skills-Based Review 🧠
Applied /grill-with-docs based on the documentation fix in this PR.
Summary
This PR correctly wraps the "Required secrets" documentation in XML comments to prevent it from leaking into AI agent prompts. This aligns otlp.md with the established pattern already used in other shared workflows like activation-app.md and gh.md.
Key Observations
- ✅ Pattern consistency: Matches the XML comment convention used across other shared workflow files
- ✅ Surgical fix: Only wraps documentation text; leaves frontmatter intact
- ✅ Correct syntax: Uses standard
<!-- -->HTML/XML comments - ✅ Solves the problem: Prevents human-readable setup instructions from appearing in agent prompts
Positive Highlights
- ✅ Minimal, focused change with clear intent
- ✅ Follows existing codebase conventions without introducing new patterns
- ✅ Addresses a real issue (documentation leakage) with the simplest possible fix
Minor Suggestion
The PR description could be slightly more explicit for future reviewers: consider mentioning that this aligns with the established convention (e.g., "Aligns otlp.md with the XML comment pattern used in activation-app.md, gh.md, etc."). However, this is a very minor point and doesn't affect the technical correctness of the change.
Verdict
Approving — This is a clean, correct fix that follows established patterns. No blocking issues. 🚀
🧠 Reviewed using Matt Pocock's skills by Matt Pocock Skills Reviewer · ● 2.1M
|
🧪 Test Quality Sentinel completed test quality analysis. No test files were added or modified in PR #33468. This PR only updates documentation (.github/workflows/shared/otlp.md with 2 line additions). Test Quality Sentinel analysis skipped. |
|
✅ PR Code Quality Reviewer completed the code quality review. |
|
🧠 Matt Pocock Skills Reviewer has completed the skills-based review. ✅ |
Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Done — recompiled all 231 workflows in 60fbf3c. Two lock files were updated ( |
There was a problem hiding this comment.
Code Review Summary
✅ Approved — This is a clean, focused change that achieves its stated goal.
What was reviewed:
- Wrapping the "Required secrets" documentation section in HTML comment tags
- Intent: Prevent documentation from leaking into AI agent prompts
- File:
.github/workflows/shared/otlp.md
Findings:
- ✅ Syntax is correct
- ✅ Change is minimal and surgical
- ✅ Achieves the stated goal of preventing prompt leakage
- ✅ Documentation remains in source for human readers
No issues found. The change is appropriate for a shared OTLP configuration component where the secrets list should be visible in source but not processed into workflow prompts.
🔎 Code quality review by PR Code Quality Reviewer · ● 1.4M
There was a problem hiding this comment.
Skills-Based Review 🧠
Applied /grill-with-docs to examine how this documentation change aligns with existing patterns and domain conventions.
Key Theme
Inconsistent pattern application: The PR introduces XML comment wrapping to prevent documentation from leaking into AI prompts in otlp.md, but three sibling files (datadog.md, sentry.md, grafana.md) with identical documentation sections remain unwrapped.
Positive Highlights
✅ Good intent: Preventing documentation leakage into AI prompts is a valid concern for shared workflow imports
✅ Clean implementation: The XML comment syntax is correct and properly closed
Verdict
Requesting changes to ensure consistent application of the new pattern. Either:
- Apply XML comment wrapping to all similar OTLP configuration files (
datadog.md,sentry.md,grafana.md), OR - Document why
otlp.mdrequires special treatment that the others do not
Inconsistent patterns across similar files create confusion and technical debt.
🧠 Reviewed using Matt Pocock's skills by Matt Pocock Skills Reviewer · ● 3.5M
|
@copilot Also apply xml comments to docs in |
…afana.md and recompile Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Done in the latest commit — XML comments applied to |
|
|
Hide Required Secrets Documentation from Rendered Output
Summary
This PR hides the "Required secrets" documentation sections in workflow configuration files by wrapping them in HTML comment tags. This prevents sensitive configuration details from appearing in rendered documentation while keeping them available in the source for reference.
Changes
Modified Files (4)
.github/workflows/shared/datadog.md<!-- -->).github/workflows/shared/grafana.md<!-- -->).github/workflows/shared/otlp.md<!-- -->).github/workflows/shared/sentry.md<!-- -->)Impact Assessment
Technical Details
Testing Recommendations
Related Commits
56f866327- Apply XML comments to docs in shared/sentry.md, datadog.md, grafana.md and recompile60fbf3c7f- Recompile workflows after otlp.md XML docs update662d6a632- Merge branch 'main' into fix-docs-xml7e90232db- Update otlp.md with XML docsLabels
documentation,non-breaking,low-impact