Skip to content

Update instructions.md: clarify defaults for timeout/max-turns/model and emphasize compile command#923

Merged
pelikhan merged 2 commits intomainfrom
copilot/fix-820bbb74-3f6e-422e-adbb-f67461de495f
Sep 18, 2025
Merged

Update instructions.md: clarify defaults for timeout/max-turns/model and emphasize compile command#923
pelikhan merged 2 commits intomainfrom
copilot/fix-820bbb74-3f6e-422e-adbb-f67461de495f

Conversation

Copy link
Contributor

Copilot AI commented Sep 18, 2025

Improves user guidance in the GitHub Agentic Workflows instructions template by addressing two key usability issues:

Clarified Default Values

Updated the engine configuration documentation to specify that timeout_minutes, max-turns, version, and model have sensible defaults and can typically be omitted. This helps users avoid unnecessary configuration complexity:

engine:
  id: claude                        # Required: coding agent identifier (claude, codex, custom)
  version: beta                     # Optional: version of the action (has sensible default)
  model: claude-3-5-sonnet-20241022 # Optional: LLM model to use (has sensible default)
  max-turns: 5                      # Optional: maximum chat iterations per run (has sensible default)

Added a clear note explaining that these optional fields can be omitted unless specific customization is needed, reducing cognitive load for new users.

Emphasized Compilation Requirement

Strengthened guidance around running gh aw compile after workflow changes:

  • Added a prominent warning banner at the top of the Best Practices section
  • Changed Best Practice Add workflow: githubnext/agentics/weekly-research #5 from "Test with gh aw compile" to "ALWAYS run gh aw compile after every change"
  • Used more emphatic language to ensure users understand compilation is mandatory for generating GitHub Actions YAML files

These changes address common user confusion about which configuration fields are required versus optional, and ensure users understand the critical step of compiling workflows after making changes.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • api.contoso.com
    • Triggering command: /tmp/go-build767655024/b281/cli.test -test.testlogfile=/tmp/go-build767655024/b281/testlog.txt -test.paniconexit0 -test.timeout=10m0s -test.v=true (dns block)
    • Triggering command: /tmp/go-build924267026/b281/cli.test -test.testlogfile=/tmp/go-build924267026/b281/testlog.txt -test.paniconexit0 -test.timeout=10m0s -test.v=true (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

…and emphasize compile command

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Update the pkg/cli/templates/instructions.md : - specify that timeout, max-turns, model, have sensible default and typically can be emitted. - insist on running the "gh aw compile" command to generate the github actions workflow **after every change** Update instructions.md: clarify defaults for timeout/max-turns/model and emphasize compile command Sep 18, 2025
Copilot AI requested a review from pelikhan September 18, 2025 07:08
@pelikhan pelikhan marked this pull request as ready for review September 18, 2025 07:16
@pelikhan pelikhan merged commit f1d0cce into main Sep 18, 2025
@pelikhan pelikhan deleted the copilot/fix-820bbb74-3f6e-422e-adbb-f67461de495f branch September 18, 2025 07:16
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