Skip to content

Commit 1093e33

Browse files
committed
docs(examples): add inline comments explaining telemetry ID overrides
1 parent 8f16e5c commit 1093e33

5 files changed

Lines changed: 8 additions & 0 deletions

File tree

examples/workflows/gemini-assistant/gemini-invoke.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ jobs:
6666
use_vertex_ai: '${{ vars.GOOGLE_GENAI_USE_VERTEXAI }}'
6767
upload_artifacts: '${{ vars.UPLOAD_ARTIFACTS }}'
6868
workflow_name: 'gemini-invoke'
69+
# Assistant workflows can be triggered by comments on either Issues or PRs.
70+
# We explicitly map both fields so the CLI can correctly categorize the interaction.
6971
github_pr_number: '${{ github.event.pull_request.number }}'
7072
github_issue_number: '${{ github.event.issue.number }}'
7173
settings: |-

examples/workflows/gemini-assistant/gemini-plan-execute.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@ jobs:
6868
use_vertex_ai: '${{ vars.GOOGLE_GENAI_USE_VERTEXAI }}'
6969
upload_artifacts: '${{ vars.UPLOAD_ARTIFACTS }}'
7070
workflow_name: 'gemini-plan-execute'
71+
# Assistant workflows can be triggered by comments on either Issues or PRs.
72+
# We explicitly map both fields so the CLI can correctly categorize the interaction.
7173
github_pr_number: '${{ github.event.pull_request.number }}'
7274
github_issue_number: '${{ github.event.issue.number }}'
7375
settings: |-

examples/workflows/issue-triage/gemini-scheduled-triage.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,8 @@ jobs:
112112
use_vertex_ai: '${{ vars.GOOGLE_GENAI_USE_VERTEXAI }}'
113113
upload_artifacts: '${{ vars.UPLOAD_ARTIFACTS }}'
114114
workflow_name: 'gemini-scheduled-triage'
115+
# Overriding default telemetry inputs because scheduled workflows lack an event payload
116+
# We pass the dynamically generated list of batch issues to the custom tracking ID field
115117
github_custom_tracking_id: '${{ steps.find_issues.outputs.issue_numbers }}'
116118
settings: |-
117119
{

examples/workflows/issue-triage/gemini-triage.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ jobs:
7979
use_vertex_ai: '${{ vars.GOOGLE_GENAI_USE_VERTEXAI }}'
8080
upload_artifacts: '${{ vars.UPLOAD_ARTIFACTS }}'
8181
workflow_name: 'gemini-triage'
82+
# Explicitly set the issue number to handle `issue_comment` triggers where the context might be ambiguous
8283
github_issue_number: '${{ github.event.issue.number }}'
8384
settings: |-
8485
{

examples/workflows/pr-review/gemini-review.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ jobs:
6565
use_vertex_ai: '${{ vars.GOOGLE_GENAI_USE_VERTEXAI }}'
6666
upload_artifacts: '${{ vars.UPLOAD_ARTIFACTS }}'
6767
workflow_name: 'gemini-review'
68+
# Explicitly set the PR number to handle `issue_comment` triggers (which GitHub treats as issues, not PRs)
6869
github_pr_number: '${{ github.event.pull_request.number }}'
6970
settings: |-
7071
{

0 commit comments

Comments
 (0)