Objective
Add documentation explaining why safe-outputs has limited scope in included files compared to main workflows.
Context
The analysis found an intentional design restriction:
- Main workflows support 38 safe-output operation types (issues, discussions, comments, labels, pull-requests, agent-tasks, etc.)
- Included files only support 1 operation type (jobs)
- The schema description states: "only jobs allowed in included files"
This restriction is not documented in the reference documentation, making it unclear why included files have reduced capabilities.
Approach
- Review
docs/src/content/docs/reference/ structure
- Locate or create appropriate documentation file for safe-outputs
- Add section explaining:
- Main workflows can use all safe-output types
- Included files are restricted to jobs only
- Rationale for the restriction
- Examples of each use case
- Reference the schema descriptions as source of truth
Files to Modify
- Create or update file in
docs/src/content/docs/reference/ directory
- Possibly update
docs/src/content/docs/reference/safe-outputs.md if it exists
Acceptance Criteria
AI generated by Plan Command for discussion #8801
Objective
Add documentation explaining why
safe-outputshas limited scope in included files compared to main workflows.Context
The analysis found an intentional design restriction:
This restriction is not documented in the reference documentation, making it unclear why included files have reduced capabilities.
Approach
docs/src/content/docs/reference/structureFiles to Modify
docs/src/content/docs/reference/directorydocs/src/content/docs/reference/safe-outputs.mdif it existsAcceptance Criteria
Related to [plan] Fix schema consistency issues found in analysis #8804