Add "events" field to command trigger for filtering active events, with separate issue and PR comment events by Copilot · Pull Request #1194 · github/gh-aw

Copilot · 2025-10-03T14:12:47Z

Summary

This PR adds an events field to the command configuration in the on section, allowing users to specify which comment-related events should trigger their command workflows using GitHub Actions event names.

Recent Updates

Latest (commit pending): Merged main branch, formatted code, ran linter (all checks passed), and successfully recompiled all 50 workflows.

Previous update: Updated documentation for the command events filtering feature in ChatOps guide, command triggers reference, and instructions template.

Implementation Checklist

Key Features

Event Filtering

Users can now specify which events should trigger their command using GitHub Actions event names:

on:
  command:
    name: my-bot
    events: [issues]  # Only respond in issue bodies

Supported event names (matching GitHub Actions "on" trigger section):

issues - Issue bodies (opened, edited, reopened)
issue_comment - Issue comments only (created, edited) - excludes PR comments
pull_request_comment - Pull request comments only (created, edited) - excludes issue comments
pull_request - Pull request bodies (opened, edited, reopened)
pull_request_review_comment - Pull request review comments (created, edited)
* - Wildcard for all comment-related events (default)

Separate Issue and PR Comment Events

The new pull_request_comment event identifier enables precise filtering:

issue_comment: Maps to GitHub Actions issue_comment event with filter github.event.issue.pull_request == null (comments on issues only)
pull_request_comment: Maps to GitHub Actions issue_comment event with filter github.event.issue.pull_request != null (comments on PRs only)

This allows workflows to target only issue comments or only PR comments, providing better control and reducing unnecessary workflow runs.

Default Behavior

Commands without the events field continue to work on all comment-related events (backward compatible).

Benefits

Reduced noise - only trigger on relevant events
Clearer intent - explicit about where commands work
Better performance - fewer unnecessary workflow runs
Precise targeting - different bots for different contexts
Schema validation - invalid event identifiers are caught at compile time
Consistent with GitHub Actions - uses the same event names as the "on" trigger section
Clean code - uses helper functions for better maintainability
Simplified API - single BuildDisjunction function handles both regular and multiline rendering
Cleaner output - improved condition expressions with fewer unnecessary parentheses
Precise comment filtering - separate issue and PR comment events
Comprehensive documentation - clear examples and explanations in user-facing docs
Up to date with main - merged latest changes from main branch

Testing

Created comprehensive unit tests for all helper functions
Added integration tests for event filtering
Manually tested various event configurations (single event, multiple events, all events)
Verified single-element arrays render without unnecessary OR operators
Added test coverage for BuildDisjunction with multiline parameter
Added tests for pull_request_comment and issue_comment filtering
All existing tests updated and passing
Linting and formatting checks pass
Schema validation tested with invalid identifiers
Verified that only GitHub Actions event names are accepted
All workflows recompiled successfully with cleaner condition output (50 workflows)
Updated tidy workflow to use pull_request_comment event
Documentation tested with workflow recompilation
Merged with main and recompiled - all workflows compile successfully

Original prompt

Add a "events" field on the "command" field in the "on" section that allows to select where the command is active. Default is all events "*", other values are "issue", "issue_comment", ...

The compiler should use this information to generate a more precise "on" section and filters.

Place helpers in "comment.go"

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

pelikhan

@copilot update schema

pelikhan · 2025-10-03T15:12:17Z

+	var commandChecks []ConditionNode
+
+	// Check which events are enabled and build appropriate checks
+	hasIssues := containsEventName(eventNames, "issues")


@copilot check plurality issue vs issues. Make it consistent.

Fixed in cf09d04. Verified that "issues" is consistently used as the canonical event name across all mappings.

pelikhan · 2025-10-03T15:13:12Z

-		Right: prBodyCheck,
+	var commandCondition ConditionNode
+	if len(commandChecks) == 0 {
+		// No events enabled, this should not happen but handle gracefully


@copilot raise compiler error

Fixed in cf09d04. Changed to panic with descriptive error message instead of returning a false condition when no valid events are specified.

pelikhan · 2025-10-03T15:13:48Z

+		commandCondition = commandChecks[0]
+	} else {
+		// Build OR chain for multiple checks
+		commandCondition = commandChecks[0]


@copilot use helper to build disjunction with array it will handle all the cases (1 and more)

Fixed in cf09d04. Replaced manual OR chain building with DisjunctionNode which elegantly handles single, multiple, and all cases.

pelikhan · 2025-10-03T15:16:22Z

 }
+
+// containsEventName checks if a slice of event names contains a specific event name
+func containsEventName(eventNames []string, eventName string) bool {


@copilot a builtin Golang string function

Fixed in cf09d04. Replaced custom containsEventName function with slices.Contains from the standard library.

pelikhan · 2025-10-03T15:23:36Z

@copilot update scout.md to target issue and issue_comment events

…a, and panic on invalid events Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2025-10-03T15:31:25Z

@copilot update schema

Fixed in cf09d04. Added enum validation to the schema with all supported event identifiers (issue, issues, comment, issue_comment, pr, pull_request, pr_review, pr_review_comment, pull_request_review_comment, and *).

Copilot · 2025-10-03T15:37:49Z

@copilot update scout.md to target issue and issue_comment events

I couldn't find scout.md in the repository. Could you provide the path to the file or let me know if this is a new file that needs to be created? If it's an existing workflow, please specify its location.

pelikhan · 2025-10-03T15:45:08Z

@copilot use event names that match the GitHub actions "on" trigger section names.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2025-10-03T15:54:24Z

@copilot use event names that match the GitHub actions "on" trigger section names.

Fixed in 52a6611. Removed all short aliases (issue, comment, pr, pr_review) and now only accept GitHub Actions event names (issues, issue_comment, pull_request, pull_request_review_comment) as specified in the "on" trigger section. Schema validation ensures only valid GitHub Actions event names are accepted.

pelikhan · 2025-10-03T16:08:58Z

+		commentEventTerms = append(commentEventTerms, BuildEventTypeEquals(eventName))
+	}
+
 	commentEventChecks := &DisjunctionNode{


@copilot

use buildDisjunction helper

make sure buildDisjunction handles case with array of size 1

Fixed in f92c045. Created BuildDisjunction helper function and used it in both places (lines 58 and 74). The helper correctly handles arrays of size 1 by leveraging DisjunctionNode.Render() which returns just the single term without OR operators for single-element arrays.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

…tion Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

pelikhan · 2025-10-03T17:43:45Z

@copilot merge main, format, lint, recompile

…ot/add-events-field-to-command

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2025-10-03T17:52:58Z

@copilot merge main, format, lint, recompile

Fixed in fba6920. Successfully merged main branch, formatted code, ran linter (all checks passed), and recompiled all 50 workflows. The recompilation produced cleaner condition expressions with fewer unnecessary parentheses thanks to the improved BuildDisjunction logic.

pelikhan

@copilot

add "pull_request_comment" event that triggers on a comment on pull_request (not issue)
update tidy.ml command to run on "pull_request_comment" event only
restrict event "issue_comment" to comments on issue only

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2025-10-03T18:35:06Z

@copilot

add "pull_request_comment" event that triggers on a comment on pull_request (not issue)...

Fixed in 9b2aba6:

Added pull_request_comment event: New event identifier that triggers on comments made on pull requests only. Maps to issue_comment GitHub Actions event with filter github.event.issue.pull_request != null.
Restricted issue_comment: Now only triggers on comments made on issues (not PRs). Adds filter github.event.issue.pull_request == null to exclude PR comments.
Updated tidy.md: Changed to use events: [pull_request_comment] so the command only responds to PR comments.

Both event identifiers map to the underlying GitHub Actions issue_comment event but with precise filters to distinguish between issue comments and PR comments.

pelikhan · 2025-10-03T18:43:32Z

@copilot

update chatops docs
update instructions.md

pelikhan · 2025-10-03T18:48:24Z

@copilot merge main, format, lint, recompile

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2025-10-03T18:51:37Z

@copilot

update chatops docs...

Updated documentation in commit a0ea28d:

ChatOps guide - Added "Filtering Command Events" section with examples and all supported event identifiers
Command triggers reference - Added complete filtering documentation with practical use cases
Instructions template - Updated command trigger section to include events field

All documentation now clearly explains the new events field, the supported event identifiers (issues, issue_comment, pull_request_comment, pull_request, pull_request_review_comment), and how issue_comment and pull_request_comment provide automatic filtering to distinguish between issue and PR comments.

…ot/add-events-field-to-command

Copilot · 2025-10-03T19:01:06Z

@copilot merge main, format, lint, recompile

Completed. Merged main branch, formatted code, ran linter (all checks passed), and successfully recompiled all 50 workflows.

Initial plan

8fba46b

Copilot AI assigned Copilot and pelikhan Oct 3, 2025

Copilot started work on behalf of pelikhan October 3, 2025 14:13 View session

Copilot AI and others added 4 commits October 3, 2025 14:18

Initial analysis of command events filtering feature

0f4f414

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Add command events filtering feature

9fd904a

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Fix linting issues and run agent-finish

9429331

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Add clarifying comment to FilterCommentEvents

3794abe

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add events field to command in on section~~ Add "events" field to command trigger for filtering active events Oct 3, 2025

Copilot finished work on behalf of pelikhan October 3, 2025 14:42

Copilot AI requested a review from pelikhan October 3, 2025 14:42

pelikhan reviewed Oct 3, 2025

View reviewed changes

Copilot started work on behalf of pelikhan October 3, 2025 15:17 View session

Address PR feedback: use slices.Contains, DisjunctionNode, enum schem…

cf09d04

…a, and panic on invalid events Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot finished work on behalf of pelikhan October 3, 2025 15:33

Copilot AI requested a review from pelikhan October 3, 2025 15:33

Copilot started work on behalf of pelikhan October 3, 2025 15:33 View session

Copilot finished work on behalf of pelikhan October 3, 2025 15:38

Copilot started work on behalf of pelikhan October 3, 2025 15:45 View session

Use GitHub Actions event names instead of short aliases

52a6611

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot AI changed the title ~~Add "events" field to command trigger for filtering active events~~ Add "events" field to command trigger for filtering active events using GitHub Actions event names Oct 3, 2025

Copilot finished work on behalf of pelikhan October 3, 2025 15:55

pelikhan reviewed Oct 3, 2025

View reviewed changes

Copilot started work on behalf of pelikhan October 3, 2025 16:10 View session

Use BuildDisjunction helper that handles single-element arrays correctly

f92c045

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot started work on behalf of pelikhan October 3, 2025 16:22 View session

Merge BuildDisjunction and BuildMultilineDisjunction into single func…

fe69e65

…tion Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot started work on behalf of pelikhan October 3, 2025 17:44 View session

Copilot AI and others added 2 commits October 3, 2025 17:48

Merge branch 'main' of https://github.com/githubnext/gh-aw into copil…

6a6bde9

…ot/add-events-field-to-command

Merge main, format, lint, and recompile workflows

fba6920

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot finished work on behalf of pelikhan October 3, 2025 17:53

pelikhan reviewed Oct 3, 2025

View reviewed changes

Copilot started work on behalf of pelikhan October 3, 2025 18:14 View session

Add pull_request_comment event and restrict issue_comment to issues only

9b2aba6

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot AI changed the title ~~Add "events" field to command trigger for filtering active events using GitHub Actions event names~~ Add "events" field to command trigger for filtering active events, with separate issue and PR comment events Oct 3, 2025

Copilot AI requested a review from pelikhan October 3, 2025 18:36

Copilot finished work on behalf of pelikhan October 3, 2025 18:36

pelikhan marked this pull request as ready for review October 3, 2025 18:42

Copilot started work on behalf of pelikhan October 3, 2025 18:44 View session

Update documentation for command events filtering feature

00eea6f

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot finished work on behalf of pelikhan October 3, 2025 18:52

Copilot started work on behalf of pelikhan October 3, 2025 18:53 View session

Merge branch 'main' of https://github.com/githubnext/gh-aw into copil…

4cef6bc

…ot/add-events-field-to-command

Copilot finished work on behalf of pelikhan October 3, 2025 19:03

pelikhan approved these changes Oct 3, 2025

View reviewed changes

pelikhan merged commit 0789657 into main Oct 3, 2025
13 checks passed

pelikhan deleted the copilot/add-events-field-to-command branch October 3, 2025 19:06

Conversation

Copilot AI commented Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Recent Updates

Implementation Checklist

Key Features

Event Filtering

Separate Issue and PR Comment Events

Default Behavior

Benefits

Testing

Uh oh!

pelikhan left a comment

Choose a reason for hiding this comment

Uh oh!

pelikhan Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

pelikhan Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

pelikhan Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

pelikhan Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

pelikhan commented Oct 3, 2025

Uh oh!

Copilot AI commented Oct 3, 2025

Uh oh!

Copilot AI commented Oct 3, 2025

Uh oh!

pelikhan commented Oct 3, 2025

Uh oh!

Copilot AI commented Oct 3, 2025

Uh oh!

pelikhan Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

pelikhan commented Oct 3, 2025

Uh oh!

Copilot AI commented Oct 3, 2025

Uh oh!

pelikhan left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Oct 3, 2025

Uh oh!

pelikhan commented Oct 3, 2025

Uh oh!

pelikhan commented Oct 3, 2025

Uh oh!

Copilot AI commented Oct 3, 2025

Uh oh!

Copilot AI commented Oct 3, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Copilot AI commented Oct 3, 2025 •

edited

Loading