diff --git a/.github/aw/create-agentic-workflow.md b/.github/aw/create-agentic-workflow.md index c615af23fb..5eb4d6dfad 100644 --- a/.github/aw/create-agentic-workflow.md +++ b/.github/aw/create-agentic-workflow.md @@ -226,6 +226,7 @@ These resources contain workflow patterns, best practices, safe outputs, and per - **Advanced static analysis** → See `.github/aw/serena-tool.md` for guidance on when and how to use Serena language server (only for advanced coding tasks when user explicitly requests it) - **Orchestration patterns** → See `.github/aw/orchestration.md` for guidance on coordinating multi-step work and tracking progress across runs (use when the workflow is acting as a coordinator) - **GitHub Projects (v2)** → See `.github/aw/projects.md` for GitHub Projects (v2) integration patterns and safe-outputs setup (use when the workflow updates project boards or posts project status updates) + - **⚡ CLI Tool Discovery** → Before configuring complex manual setup, check if `gh aw` provides a CLI command for the task (see CLI Automation Discovery section below) - ⚠️ For GitHub write operations (creating issues, adding comments, etc.), always use `safe-outputs` instead of GitHub tools @@ -321,6 +322,15 @@ These resources contain workflow patterns, best practices, safe outputs, and per **DO NOT use `post-steps:` for these scenarios.** `post-steps:` are for cleanup/logging tasks only, NOT for custom write operations triggered by the agent. + **CLI Automation Discovery:** + + ⚡ **IMPORTANT**: Before recommending manual setup, check if `gh aw` provides a CLI command (use `gh aw --help` to explore). Examples: + - `gh aw project new --with-project-setup` - Creates project boards with views and fields + - `gh aw secrets` - Manages repository secrets + - `gh aw init` / `gh aw new` / `gh aw add` - Repository and workflow setup + + **For GitHub Projects workflows**: Recommend `gh aw project new "Title" --owner org --with-project-setup` instead of manual board/field creation + **Security Education for Common Patterns:** When creating workflows with certain patterns, always educate users about security risks: diff --git a/.github/aw/projects.md b/.github/aw/projects.md index 869dde1200..3af9d9e535 100644 --- a/.github/aw/projects.md +++ b/.github/aw/projects.md @@ -17,9 +17,10 @@ Use GitHub Projects safe-outputs when designing workflows that: ## Core Projects Patterns +- **Create projects with automation** - Use `gh aw project new --with-project-setup` for quick setup with standard views and fields (recommended) - **Track items and fields** with `update-project` (add issue/PR items, create/update fields, optionally create views) - **Post periodic run summaries** with `create-project-status-update` (status, dates, and a concise markdown summary) -- **Create new projects** with `create-project` (optional; prefer manual creation unless automation is explicitly desired) +- **Create new projects programmatically** with `create-project` safe-output (advanced; prefer CLI for initial setup) ## Prerequisites and Authentication