Skip to content

Update README to document gh aw add / gh aw update workflow installation#3

Merged
mnkiefer merged 4 commits intomainfrom
copilot/update-readme-with-usage-instructions
Apr 29, 2026
Merged

Update README to document gh aw add / gh aw update workflow installation#3
mnkiefer merged 4 commits intomainfrom
copilot/update-readme-with-usage-instructions

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 29, 2026

The README described these agentic workflows as reusable via GitHub Actions uses:, which is not how they are consumed. This updates the docs to show the supported install and update path with gh aw.

  • Usage model

    • Replaces the uses:-based integration guidance with explicit gh aw add instructions
    • Clarifies that consumers should import the workflow source into their own repository, not reference this repo at runtime
  • Supported entry points

    • Documents add commands for:
      • dependabot-review (installed from dependabot-repair.md with --name)
      • dependabot-campaign
      • dependabot-review-reusable (installed from dependabot-repair-reusable.md with --name)
  • Ongoing maintenance

    • Adds gh aw update examples for each imported workflow
    • Notes that consumers should review and commit both the imported .md file and generated .lock.yml
    • Explains that the upstream source filenames in this repository still use dependabot-repair, while the consumer-facing installed workflow names use dependabot-review
  • README cleanup

    • Removes the old reusable-workflow YAML examples and outdated path reference
    • Keeps the distinction between local review behavior and centralized campaign coordination

Example:

gh aw add githubnext/dependabot-campaign/.github/workflows/dependabot-repair.md --name dependabot-review
gh aw update dependabot-review

Copilot AI and others added 2 commits April 29, 2026 11:05
@mnkiefer
Copy link
Copy Markdown
Contributor

@copilot Rename dependabot-repair to dependabot-review

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 29, 2026

@copilot Rename dependabot-repair to dependabot-review

Updated in 1c53cf1 to use dependabot-review / dependabot-review-reusable as the consumer-facing workflow names in the README examples.

Copilot AI requested a review from mnkiefer April 29, 2026 11:36
@mnkiefer mnkiefer marked this pull request as ready for review April 29, 2026 11:43
@mnkiefer mnkiefer merged commit 7792e60 into main Apr 29, 2026
5 of 6 checks passed
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.

2 participants