Skip to content

[Code Quality] Add autofix-code-scanning-alert documentation to safe-outputs reference #12418

@github-actions

Description

@github-actions

The autofix-code-scanning-alert safe-output operation is fully implemented and defined in the schema but is completely missing from the user documentation, preventing users from discovering and using this feature.

Source

Extracted from Safe-Outputs Comprehensive Audit discussion #12389

Problem

  • Schema: Fully defined in pkg/parser/schemas/main_workflow_schema.json with complete parameter specification
  • Implementation: Complete Go implementation in pkg/workflow/autofix_code_scanning_alert.go
  • Documentation: Missing from docs/src/content/docs/reference/safe-outputs.md

Users cannot discover or use this feature because it's not documented in the safe-outputs reference.

Files Affected

  • docs/src/content/docs/reference/safe-outputs.md - Add new section

Suggested Changes

Add a new section under "Security & Agent Tasks" category in the safe-outputs reference documentation with:

  1. Description: Explain what autofix-code-scanning-alert does (creates automated fixes for code scanning alerts)
  2. Parameters: Document all available parameters (from schema)
  3. YAML Example: Show realistic usage example
  4. Usage Notes: When to use vs other safe-output operations

Success Criteria

  • Documentation section added to safe-outputs.md
  • All parameters documented with descriptions
  • At least one working YAML example included
  • Documentation passes markdown linting
  • Feature is discoverable in documentation search

Priority

High - Missing documentation prevents users from discovering an existing feature. Quick fix with high impact on feature adoption.

Estimated Effort

1-2 hours - Straightforward documentation task with existing schema and implementation as references.

AI generated by Discussion Task Miner - Code Quality Improvement Agent

  • expires on Feb 12, 2026, 1:34 AM UTC

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions