[docs] Update glossary - weekly full scan#19192
Conversation
… Ephemerals Weekly full scan (2026-03-02) identified four new user-facing terms introduced in recent changes: - Custom Safe Outputs: jobs: section for third-party integrations - Assign to Agent: assign-to-agent: safe output for Copilot coding agent - Stop After: stop-after: workflow time-limit field - Ephemerals: category for auto-expiring workflow resources Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates the documentation glossary to add missing entries discovered in the weekly full scan (2026-03-02), covering newly documented workflow/safe-output concepts.
Changes:
- Added glossary entries for Assign to Agent and Custom Safe Outputs
- Added glossary entry for Stop After (
stop-after:) workflow trigger deadline behavior - Added glossary entry for Ephemerals as the umbrella concept for expiration/noise-reduction features
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ### Stop After | ||
|
|
||
| A workflow configuration field (`stop-after:`) that automatically prevents new runs after a specified time limit. Accepts absolute dates (`YYYY-MM-DD`, ISO 8601) or relative time deltas (`+48h`, `+7d`). Minimum granularity is hours. Useful for trial periods, experimental features, and cost-controlled schedules. Recompile with `gh aw compile --refresh-stop-time` to reset the deadline. See [Ephemerals](/gh-aw/guides/ephemerals/). |
There was a problem hiding this comment.
The Stop After entry understates the accepted absolute date formats. The Triggers reference documents additional supported absolute formats (e.g., MM/DD/YYYY, DD/MM/YYYY, January 2 2006, 1st June 2025) beyond YYYY-MM-DD/ISO 8601; consider wording this as “supports multiple absolute date formats (including …)” to avoid implying only those two formats are valid. Also consider clarifying that stop-after: is configured under the on: trigger section (see docs/src/content/docs/reference/frontmatter.md:27-39).
| A workflow configuration field (`stop-after:`) that automatically prevents new runs after a specified time limit. Accepts absolute dates (`YYYY-MM-DD`, ISO 8601) or relative time deltas (`+48h`, `+7d`). Minimum granularity is hours. Useful for trial periods, experimental features, and cost-controlled schedules. Recompile with `gh aw compile --refresh-stop-time` to reset the deadline. See [Ephemerals](/gh-aw/guides/ephemerals/). | |
| A workflow trigger configuration field (`stop-after:` under the `on:` section) that automatically prevents new runs after a specified time limit. Supports multiple absolute date formats (including `YYYY-MM-DD`, ISO 8601, `MM/DD/YYYY`, `DD/MM/YYYY`, `January 2 2006`, `1st June 2025`) as well as relative time deltas (`+48h`, `+7d`). Minimum granularity is hours. Useful for trial periods, experimental features, and cost-controlled schedules. Recompile with `gh aw compile --refresh-stop-time` to reset the deadline. See [Ephemerals](/gh-aw/guides/ephemerals/). |
|
|
||
| ### Ephemerals | ||
|
|
||
| A category of features for automatically expiring workflow resources to reduce repository noise and control costs. Includes workflow stop-after scheduling, safe output expiration (auto-closing issues, discussions, and pull requests), and hidden older status comments. See [Ephemerals](/gh-aw/guides/ephemerals/). |
There was a problem hiding this comment.
The Ephemerals definition says it includes “hidden older status comments”, but the guide/reference feature is hide-older-comments (general comment minimization) and it isn’t limited to “status” comments. Suggest rephrasing to “hiding older comments” / “minimizing older workflow comments” to match the documented feature name and scope (see docs/src/content/docs/guides/ephemerals.md:102-117).
| A category of features for automatically expiring workflow resources to reduce repository noise and control costs. Includes workflow stop-after scheduling, safe output expiration (auto-closing issues, discussions, and pull requests), and hidden older status comments. See [Ephemerals](/gh-aw/guides/ephemerals/). | |
| A category of features for automatically expiring workflow resources to reduce repository noise and control costs. Includes workflow stop-after scheduling, safe output expiration (auto-closing issues, discussions, and pull requests), and minimizing older workflow comments. See [Ephemerals](/gh-aw/guides/ephemerals/). |
Glossary Updates - 2026-03-02
Scan Type
Terms Added
jobs:mechanism undersafe-outputsfor third-party integrations was added viacustom-safe-outputs.mdreference doc but had no glossary entry.assign-to-agent:safe output for programmatically assigning the Copilot coding agent was documented inassign-to-copilot.mdxbut missing from the glossary.stop-after:workflow field for time-based auto-stop was documented inephemerals.mdbut missing from the glossary.guides/ephemerals.mdbut had no glossary entry.Terms Updated
None.
Changes Analyzed
required_statetogh aw checks --jsonto isolate CI verdict from optional third-party commit statuses #19161 (required_state), [docs] Update documentation for features from 2026-03-02 #19165 (docs update), Detecttriggers:keyword misuse in compile with actionable error #19142 (triggers: detection)Related Changes
88319be– PR 🔑 Rename safe-output-projects to safe-output-custom-tokens #19156: Rename safe-output-projects to safe-output-custom-tokens (broadened custom token support)e9daf17– PR [docs] Update documentation for features from 2026-03-02 #19165: Documentation update for 2026-03-02 features (errors.md updates)ephemerals.md– Existing guide describing stop-after, issue expiration, and auto-close featuresNotes
The
required_statefield added togh aw checks --json(PR #19161) is an internal CLI output field, not user-facing configuration, so it was not added to the glossary. Thesafe-output-custom-tokensrename (PR #19156) is an internal implementation detail — not user-visible configuration — so it also did not warrant a glossary entry.