Skip to content

Add autofix-code-scanning-alert documentation to safe-outputs reference#12422

Merged
pelikhan merged 5 commits intomainfrom
copilot/add-autofix-code-scanning-docs
Jan 29, 2026
Merged

Add autofix-code-scanning-alert documentation to safe-outputs reference#12422
pelikhan merged 5 commits intomainfrom
copilot/add-autofix-code-scanning-docs

Conversation

Copy link
Contributor

Copilot AI commented Jan 29, 2026

Add autofix-code-scanning-alert documentation to safe-outputs reference

  • Review schema, implementation, and existing usage examples
  • Add entry to "Security & Agent Tasks" section list
  • Add detailed documentation section after "Code Scanning Alerts"
  • Include parameters documentation (max, github-token)
  • Add YAML configuration example
  • Add usage notes and guidelines
  • Verify markdown formatting and links
  • Test documentation builds correctly
  • Add repository scope specification to TOC entry for consistency
  • Simplify documentation to match style of adjacent sections

Summary

Added concise documentation for the autofix-code-scanning-alert safe-output operation:

  • Entry in TOC under "Security & Agent Tasks" with consistent formatting (max: 10, same-repo only)
  • Simple documentation section matching the style of adjacent Code Scanning Alerts section
  • YAML example showing max parameter configuration

The feature is now documented and discoverable in the safe-outputs reference.

Original prompt

This section details on the original issue you should resolve

<issue_title>[Code Quality] Add autofix-code-scanning-alert documentation to safe-outputs reference</issue_title>
<issue_description>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 githubnext/gh-aw#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

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 3 commits January 29, 2026 02:52
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Add autofix-code-scanning-alert documentation to safe-outputs reference Add autofix-code-scanning-alert documentation to safe-outputs reference Jan 29, 2026
Copilot AI requested a review from pelikhan January 29, 2026 03:01
@pelikhan pelikhan marked this pull request as ready for review January 29, 2026 03:12
- **`max`** (optional) — Maximum number of autofixes to create per workflow run (default: 10, minimum: 1)
- **`github-token`** (optional) — Custom GitHub token for this specific output type. Overrides global `github-token` if specified.

#### Agent Output Format
Copy link
Contributor

Choose a reason for hiding this comment

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

@copilot keep it simple

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Simplified documentation to match the style of the adjacent Code Scanning Alerts section. Removed detailed subsections and kept it concise. (e3bea71)

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI requested a review from pelikhan January 29, 2026 03:18
@pelikhan pelikhan merged commit b6ed5cd into main Jan 29, 2026
@pelikhan pelikhan deleted the copilot/add-autofix-code-scanning-docs branch January 29, 2026 03:18
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.

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

2 participants