Skip to content

[instructions] Sync instruction files — fix cli-proxy and reduce safe-outputs.md#30359

Merged
pelikhan merged 1 commit intomainfrom
instructions-janitor/sync-instruction-files-2026-05-05-94e06edc0eafbda3
May 5, 2026
Merged

[instructions] Sync instruction files — fix cli-proxy and reduce safe-outputs.md#30359
pelikhan merged 1 commit intomainfrom
instructions-janitor/sync-instruction-files-2026-05-05-94e06edc0eafbda3

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot commented May 5, 2026

Instructions Update — Sync after recent changes

This PR updates instruction files in .github/aw/ based on audit of current code vs. documentation accuracy and file size limits.

Files Changed

  • syntax.md: Fix cli-proxy feature flag description — previous wording conflated cli-proxy and integrity-reactions by saying "and reaction-based integrity decisions" and including integrity-reactions-specific content ("Compiler automatically enables cli-proxy") in the cli-proxy entry. Corrected to describe cli-proxy's actual purpose (secure read-only gh CLI access without exposing GITHUB_TOKEN) and clarify it is a prerequisite for integrity-reactions.

  • safe-outputs.md: Reduce from 1058 lines to 994 lines (below hard limit of 1000) by:

    • Removing ~18 redundant "When using safe-outputs.X, the main job does not need write permissions" sentences (this principle is already stated in the file's introduction)
    • Condensing the "Output Processing and Issue Creation" section (35 lines) to a compact "Output Variables" table (11 lines) — the rest was duplicated with earlier content
    • Streamlining create-project: and update-project: PAT token requirements that were duplicated across 3 sections

Documentation Commits Reviewed

  • 178adc3 feat: split github-agentic-workflows.md into focused sub-files and update instructions-janitor

All changeset files were reviewed. All documented features are consistent with current code.

Size Audit

File Before After Status
github-agentic-workflows.md 193 lines 193 lines ✓ (< 250 limit)
safe-outputs.md 1058 lines 994 lines ✓ (< 1000 hard limit)
syntax.md 932 lines 932 lines ✓ (< 1000 hard limit)

Validation

  • Followed prompting best practices (imperative mood, minimal examples)
  • Maintained technical tone and brevity
  • Updated the correct sub-file for each change
  • No content duplication introduced between files
  • File sizes within target limits
  • Verified accuracy against current codebase (changeset files, schema, code)

Generated by Instructions Janitor · ● 1.2M ·

  • expires on May 7, 2026, 1:11 PM UTC

…tputs.md size

- syntax.md: Fix cli-proxy feature flag description to accurately describe
  its purpose (secure read-only gh CLI access without exposing GITHUB_TOKEN)
  and clarify its relationship with integrity-reactions (prerequisite, not
  the same feature)

- safe-outputs.md: Reduce from 1058 to 994 lines (below hard limit of 1000)
  by removing ~18 redundant "When using safe-outputs.X, the main job does
  not need write permissions" sentences (already covered in the file intro),
  condensing the Output Processing section to a compact Output Variables
  table, and streamlining the create-project and update-project token
  requirements that were duplicated across three sections

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation instructions labels May 5, 2026
@pelikhan pelikhan merged commit b25619d into main May 5, 2026
@pelikhan pelikhan deleted the instructions-janitor/sync-instruction-files-2026-05-05-94e06edc0eafbda3 branch May 5, 2026 13:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation instructions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant