Skip to content

docs: fix update-pr missing update-description operation in prompt and README #1177

Description

@github-actions

Documentation Freshness Audit

This audit found the following inconsistency between code and documentation:

Findings

Area Issue File(s)
Safe output tool description update-pr tool description omits the update-description operation prompts/create-ado-agentic-workflow.md, README.md

Details

The update-pr safe-output tool supports five operations, as defined in src/safeoutputs/update_pr.rs:

const VALID_OPERATIONS: &[&str] = &[
    "add-reviewers",
    "add-labels",
    "set-auto-complete",
    "vote",
    "update-description",  // ← was missing from docs
];

docs/safe-outputs.md correctly lists all five operations:

operation - Update operation: add-reviewers, add-labels, set-auto-complete, vote, or update-description

However, both prompts/create-ado-agentic-workflow.md (the primary AI agent authoring guide) and README.md omitted update-description:

  • Before: Update PR metadata (reviewers, labels, auto-complete, vote)
  • After: Update PR metadata (reviewers, labels, auto-complete, vote, update-description)

Applied Fixes

  • Updated update-pr row in prompts/create-ado-agentic-workflow.md to include update-description
  • Updated update-pr row in README.md to explicitly list all five operations

This pull request was created by the automated documentation freshness check.


Warning

Protected Files — Push Permission Denied

This was originally intended as a pull request, but the patch modifies protected files. A human must create the pull request manually.

Protected files
  • README.md

The push was rejected because GitHub Actions does not have workflows permission to push these changes, and is never allowed to make such changes, or other authorization being used does not have this permission.

Create the pull request manually
# Download the patch from the workflow run
gh run download 28068414989 -n agent -D /tmp/agent-28068414989

# Create a new branch
git checkout -b docs/fix-update-pr-description-operation-f16fe9a0bb4aac36 main

# Apply the patch (--3way handles cross-repo patches)
git am --3way /tmp/agent-28068414989/aw-docs-fix-update-pr-description-operation.patch

# Push the branch and create the pull request
git push origin docs/fix-update-pr-description-operation-f16fe9a0bb4aac36
gh pr create --title 'docs: fix update-pr missing update-description operation in prompt and README' --base main --head docs/fix-update-pr-description-operation-f16fe9a0bb4aac36 --repo githubnext/ado-aw

Generated by Documentation Freshness Check · 3.7K AIC · ⌖ 18.9 AIC · ⊞ 36.2K ·

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions