Skip to content

docs: expand "Write Operations Fail" troubleshooting stub in common-issues.md#21519

Merged
pelikhan merged 2 commits intomainfrom
copilot/expand-write-operations-fail
Mar 18, 2026
Merged

docs: expand "Write Operations Fail" troubleshooting stub in common-issues.md#21519
pelikhan merged 2 commits intomainfrom
copilot/expand-write-operations-fail

Conversation

Copy link
Contributor

Copilot AI commented Mar 18, 2026

The "Write Operations Fail" section was a two-sentence stub while every adjacent section provides YAML examples, links, and step-by-step guidance — a common onboarding friction point.

Changes

  • docs/src/content/docs/troubleshooting/common-issues.md
    • Replaces the stub with an explanation of why direct writes are disallowed and how safe-outputs acts as the intermediary
    • Adds a YAML frontmatter example showing create-issue (with config) alongside add-comment and update-issue (defaults, annotated inline)
    • Links to the Safe Outputs reference and specification pages for further reading
safe-outputs:
  create-issue:
    title-prefix: "[bot] "
    labels: [automation]
  add-comment:      # no configuration required; uses defaults
  update-issue:     # no configuration required; uses defaults

📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] [plan] Expand 'Write Operations Fail' troubleshooting entry docs: expand "Write Operations Fail" troubleshooting stub in common-issues.md Mar 18, 2026
Copilot AI requested a review from pelikhan March 18, 2026 02:55
@pelikhan pelikhan marked this pull request as ready for review March 18, 2026 03:01
Copilot AI review requested due to automatic review settings March 18, 2026 03:01
@pelikhan pelikhan merged commit 0eabbbe into main Mar 18, 2026
58 checks passed
@pelikhan pelikhan deleted the copilot/expand-write-operations-fail branch March 18, 2026 03:01
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Expands the troubleshooting guidance for “Write Operations Fail” by explaining the write-safety model and showing how to declare required safe-outputs in workflow frontmatter.

Changes:

  • Replaces the prior stub with an explanation that write operations must be executed via safe-outputs.
  • Adds a YAML example demonstrating configured (create-issue) and default (add-comment, update-issue) safe outputs.
  • Links to the Safe Outputs reference and the Safe Outputs specification for follow-up details.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[plan] Expand "Write Operations Fail" troubleshooting entry in common-issues.md

3 participants