Skip to content

[docs] Update glossary - daily scan #20328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 1 commit into from
Mar 10, 2026
Merged

[docs] Update glossary - daily scan #20328

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/src/content/docs/reference/glossary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,17 @@ Access controls defining workflow operations. Workflows follow least privilege,

Customizable messages workflows can display during execution. Configured in `safe-outputs.messages` with types `run-started`, `run-success`, `run-failure`, and `footer`. Supports GitHub context variables like `{workflow_name}` and `{run_url}`.

### Failure Issue Reporting (`report-failure-as-issue:`)

A `safe-outputs` option controlling whether workflow run failures are automatically reported as GitHub issues. Defaults to `true` when safe outputs are configured. Set to `false` to suppress failure issue creation for workflows where failures are expected or handled externally:
Copy link

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

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

The default is described as "Defaults to true when safe outputs are configured", but the option itself is simply a boolean with default true (and only applies when safe-outputs is present). Consider rephrasing to match the Safe Outputs reference/schema wording (e.g., "default: true") to avoid implying the default changes based on whether safe outputs are configured.

Suggested change
A `safe-outputs` option controlling whether workflow run failures are automatically reported as GitHub issues. Defaults to `true` when safe outputs are configured. Set to `false` to suppress failure issue creation for workflows where failures are expected or handled externally:
A `safe-outputs` option controlling whether workflow run failures are automatically reported as GitHub issues (default: `true`). Set to `false` to suppress failure issue creation for workflows where failures are expected or handled externally:

Copilot uses AI. Check for mistakes.

```yaml
safe-outputs:
report-failure-as-issue: false
```

See [Safe Outputs Reference](/gh-aw/reference/safe-outputs/).

### Upload Assets

A safe output capability for uploading generated files (screenshots, charts, reports) to an orphaned git branch for persistent storage. The AI calls the `upload_asset` tool to register files, which are committed to a dedicated assets branch by a separate permission-controlled job. Assets are accessible via GitHub raw URLs. Commonly used for visual testing artifacts, data visualizations, and generated documentation.
Expand Down