Skip to content

[docs-drift] Document gh-aw-upgrade-check internal workflow #22

Description

@github-actions

Recent code changes in the repository have introduced documentation drift. The following changes need corresponding documentation updates.

Changes Requiring Documentation Updates

1. New gh-aw-upgrade-check internal workflow is undocumented

Commit(s): 319d6a3 (PR #19)
What changed: A new gh-aw-upgrade-check workflow was added in .github/workflows/gh-aw-upgrade-check.md and .github/workflows/gh-aw-upgrade-check.lock.yml. This is an internal-only scheduled workflow (no shim in gh-agent-workflows/) that runs on weekdays to check for new gh-aw releases and file issues tagged [gh-aw-upgrade]. It imports scheduled-report/rwx.md, the same reusable prompt used by docs-drift.
Documentation impact: The workflow is not mentioned in any documentation file. It should be documented in gh-agent-workflows/DEVELOPING.md since that file covers the architecture, internal workflows, and the scheduled-report/rwx.md reusable prompt pattern. Specifically:

  • The architecture tree in gh-agent-workflows/DEVELOPING.md (line 7-27) should note that gh-aw-upgrade-check exists as an internal-only workflow in .github/workflows/ that also imports scheduled-report/rwx.md
  • The "Reusable prompts" section (line 53-64) already uses docs-drift.md as the example; it would be helpful to mention gh-aw-upgrade-check as a second consumer to illustrate the reuse pattern
  • Consider documenting it in root DEVELOPING.md alongside the repository structure table, or in a note about internal workflows that live directly in .github/workflows/

Note: This workflow is correctly omitted from the consumer-facing tables in README.md and gh-agent-workflows/README.md since it's not installable via gh aw add.

Suggested Actions

  • Add gh-aw-upgrade-check to gh-agent-workflows/DEVELOPING.md — mention it as an internal workflow that uses the scheduled-report/rwx.md reusable prompt, alongside docs-drift
  • Consider adding a brief note in root DEVELOPING.md about internal-only workflows that live directly in .github/workflows/ (like gh-aw-upgrade-check, ci.yml, release.yml)

Generated by Docs Drift

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions