Implement output field for automatic GitHub issue creation with comprehensive documentation

[Copilot]

This PR implements the output field in workflow frontmatter to enable automatic creation of GitHub issues from AI agent output. The implementation uses job output variables and environment variables for configuration, providing a robust and maintainable approach with proper permission separation.

New Schema Support

The frontmatter now supports an output section with issue configuration:

---
on: push
permissions:
  contents: read      # Main job only needs minimal permissions
  actions: read
engine: claude
output:
  issue:
    title-prefix: "[genai] "  # Optional prefix for issue titles
    labels: [copilot, automation]  # Optional labels to attach
---

Generated Workflow Behavior

When the output.issue configuration is present, the compiler automatically generates a create_output_issue job that:

• Depends on the main agent job - Runs only after the AI agent completes
• Uses job output variables - Agent content flows via AGENT_OUTPUT_CONTENT: ${{ needs.[main-job].outputs.output }}
• Environment variable configuration - Settings passed via GITHUB_AW_ISSUE_TITLE_PREFIX and GITHUB_AW_ISSUE_LABELS
• Parses title and body - Uses the first non-empty line as title, rest as body
• Creates GitHub issue - Uses actions/github-script@v7 to call the GitHub API
• Scoped permissions - Only the create_output_issue job has issues: write permission
• Includes timeout - 10-minute timeout to prevent hanging
• Provides outputs - Returns issue_number and issue_url for downstream jobs

Key Benefits

Permission Separation: The main job doesn't need issues: write permission since issue creation is handled by a separate job with appropriate permissions, following the principle of least privilege.

Job Output Flow: The agent output content properly flows from the main job to the issue creation job through GitHub Actions job outputs, eliminating file-based dependencies that don't work across job boundaries.

Environment Variable Configuration: The JavaScript code reads configuration from environment variables rather than being template-generated, making it more maintainable and easier to debug.

TypeScript Support: Added tsconfig.json and a make js task for validating JavaScript code quality.

Example: Test Claude Workflow

The test-claude workflow demonstrates this functionality:

---
permissions:
  contents: read
  pull-requests: write
  actions: read
output:
  issue:
    title-prefix: "[claude-test] "
    labels: [claude, automation, haiku]
---

When this workflow runs, it automatically creates GitHub issues from Claude's haiku output about PR changes, with titles prefixed by "[claude-test] " and tagged with the specified labels.

Comprehensive Documentation

Updated all documentation files to include detailed information about the output field:

• docs/frontmatter.md: Complete reference with examples and security benefits
• pkg/cli/templates/instructions.md: Added output processing section and permission patterns
• README.md: Updated main example to demonstrate the new functionality

The documentation emphasizes that with output processing, workflows can use minimal permissions on the main job while still creating GitHub issues automatically.

This feature enables powerful automation workflows where AI agents can automatically document their findings, create task lists, or report results as GitHub issues without manual intervention or elevated permissions.

Fixes #124.

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[pelikhan]

@copilot Make the test-claude workflow use the output: issue output type.

[Copilot]

@copilot Make the test-claude workflow use the output: issue output type.

Done! I've updated the test-claude workflow to use the output: issue functionality. The workflow now includes:

• output.issue configuration with title prefix "[claude-test] " and labels [claude, automation, haiku]
• Updated permissions from issues: read to issues: write to enable issue creation
• Automatic generation of a create_output_issue job in the compiled workflow

When the workflow runs, it will automatically create GitHub issues from Claude's haiku output about PR changes, demonstrating the new output field feature in action.

Commit: 4a91dd5

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-build815417176/b278/cli.test -test.testlogfile=/tmp/go-build815417176/b278/testlog.txt -test.paniconexit0 -test.timeout=10m0s -test.v=true (dns block)
  • Triggering command: /tmp/go-build3481369641/b278/cli.test -test.testlogfile=/tmp/go-build3481369641/b278/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:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

[Copilot]

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

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-build725163811/b278/cli.test -test.testlogfile=/tmp/go-build725163811/b278/testlog.txt -test.paniconexit0 -test.timeout=10m0s -test.v=true (dns block)
  • Triggering command: /tmp/go-build2995692153/b278/cli.test -test.testlogfile=/tmp/go-build2995692153/b278/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:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

[pelikhan]

@copilot use the agent log output variables, not the GOTHUB_AW_OUTPUT env var for the issue creation. Thé env does not exist in the create issue job.

[Copilot]

@copilot use the agent log output variables, not the GOTHUB_AW_OUTPUT env var for the issue creation. Thé env does not exist in the create issue job.

Fixed! The issue creation job now uses the agent output variables instead of the GITHUB_AW_OUTPUT env var. The JavaScript code now reads from AGENT_OUTPUT_CONTENT: ${{ needs.[main-job].outputs.output }} which properly flows the agent output from the main job to the issue creation job. This eliminates the dependency on the file-based approach that wasn't available in the separate job context.

Commit: 5eed493

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-build1003461864/b278/cli.test -test.testlogfile=/tmp/go-build1003461864/b278/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:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

[pelikhan]

@copilot update documentation and instructions.md . Remember with this output field, the main job does not need issue: write because the write operation is done in a separate job.

[Copilot]

@copilot update documentation and instructions.md . Remember with this output field, the main job does not need issue: write because the write operation is done in a separate job.

Updated documentation across frontmatter.md, instructions.md, and README.md to include comprehensive information about the output field and its benefits. Key highlights:

• Permission Separation: Documented that the main job doesn't need issues: write permission when using output processing
• Automatic Issue Creation: Added detailed explanation of how the output.issue configuration works
• Permission Patterns: Updated examples to show the recommended output processing pattern vs direct issue management
• Security Benefits: Emphasized principle of least privilege with separate job permissions

Commit: d32c1e0

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-build737744547/b278/cli.test -test.testlogfile=/tmp/go-build737744547/b278/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:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)