Skip to content

[tidy] Update template documentation with security scanner flags #3044

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 1 commit into from
Nov 3, 2025
Merged

[tidy] Update template documentation with security scanner flags #3044

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions pkg/cli/templates/github-agentic-workflows.instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1097,6 +1097,9 @@ Agentic workflows compile to GitHub Actions YAML:
- Example: `gh aw compile issue-triage` compiles `issue-triage.md`
- Supports partial matching and fuzzy search for workflow names
- **`gh aw compile --purge`** - Remove orphaned `.lock.yml` files that no longer have corresponding `.md` files
- **`gh aw compile --zizmor`** - Run zizmor security scanner on compiled workflows
- **`gh aw compile --poutine`** - Run poutine security scanner on compiled workflows
- **`gh aw compile --strict --zizmor`** - Strict mode with security scanning (fails on findings)

## Best Practices

Expand All @@ -1114,6 +1117,7 @@ Agentic workflows compile to GitHub Actions YAML:
10. **Monitor costs with `gh aw logs`** to track AI model usage and expenses
11. **Use `--engine` filter** in logs command to analyze specific AI engine performance
12. **Prefer sanitized context text** - Use `${{ needs.activation.outputs.text }}` instead of raw `github.event` fields for security
13. **Run security scanners** - Use `--zizmor` or `--poutine` flags to scan compiled workflows for security issues

## Validation

Expand Down