Skip to content

Commit 3249628

Browse files
authored
feat(docs): improve manual setup instructions for workflows (#263)
The `gemini-dispatch.yml` workflow is designed to call other workflows like `gemini-review.yml`, `gemini-triage.yml`, and `gemini-invoke.yml`. When a user manually sets up only one of these workflows (e.g., only for PR reviews), they might not have the other workflow files present in their repository. This can lead to errors when the dispatch workflow tries to call a non-existent workflow. This change adds a note to the setup instructions for each of the main workflows (`pr-review`, `issue-triage`, `gemini-assistant`) advising users to comment out the unused jobs in their copy of `gemini-dispatch.yml`. This prevents errors and makes the manual setup process more robust. Fixes #256
1 parent 6840824 commit 3249628

3 files changed

Lines changed: 15 additions & 0 deletions

File tree

examples/workflows/gemini-assistant/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ In this guide you will learn how to use the Gemini CLI Assistant via GitHub Acti
88
- [Setup](#setup)
99
- [Prerequisites](#prerequisites)
1010
- [Setup Methods](#setup-methods)
11+
- [Dependencies](#dependencies)
1112
- [Usage](#usage)
1213
- [Supported Triggers](#supported-triggers)
1314
- [How to Invoke the Gemini CLI Workflow](#how-to-invoke-the-gemini-cli-workflow)
@@ -58,6 +59,10 @@ curl -o .github/workflows/gemini-dispatch.yml https://raw.githubusercontent.com/
5859
curl -o .github/workflows/gemini-invoke.yml https://raw.githubusercontent.com/google-github-actions/run-gemini-cli/main/examples/workflows/gemini-assistant/gemini-invoke.yml
5960
```
6061

62+
> **Note:** The `gemini-dispatch.yml` workflow is designed to call multiple
63+
> workflows. If you are only setting up `gemini-invoke.yml`, you should comment out or
64+
> remove the other jobs in your copy of `gemini-dispatch.yml`.
65+
6166
## Dependencies
6267

6368
This workflow relies on the [gemini-dispatch.yml](../gemini-dispatch/gemini-dispatch.yml) workflow to route requests to the appropriate workflow.

examples/workflows/issue-triage/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ This document describes a comprehensive system for triaging GitHub issues using
88
- [Setup](#setup)
99
- [Prerequisites](#prerequisites)
1010
- [Setup Methods](#setup-methods)
11+
- [Dependencies](#dependencies)
1112
- [Usage](#usage)
1213
- [Supported Triggers](#supported-triggers)
1314
- [Real-Time Issue Triage](#real-time-issue-triage)
@@ -62,6 +63,10 @@ curl -o .github/workflows/gemini-triage.yml https://raw.githubusercontent.com/go
6263
curl -o .github/workflows/gemini-scheduled-triage.yml https://raw.githubusercontent.com/google-github-actions/run-gemini-cli/main/examples/workflows/issue-triage/gemini-scheduled-triage.yml
6364
```
6465

66+
> **Note:** The `gemini-dispatch.yml` workflow is designed to call multiple
67+
> workflows. If you are only setting up `gemini-triage.yml`, you should comment out or
68+
> remove the other jobs in your copy of `gemini-dispatch.yml`.
69+
6570
You can customize the prompts and settings in the workflow files to suit your specific needs. For example, you can change the triage logic, the labels that are applied, or the schedule of the scheduled triage.
6671

6772
## Dependencies

examples/workflows/pr-review/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ This document explains how to use the Gemini CLI on GitHub to automatically revi
88
- [Setup](#setup)
99
- [Prerequisites](#prerequisites)
1010
- [Setup Methods](#setup-methods)
11+
- [Dependencies](#dependencies)
1112
- [Usage](#usage)
1213
- [Supported Triggers](#supported-triggers)
1314
- [Interaction Flow](#interaction-flow)
@@ -70,6 +71,10 @@ curl -o .github/workflows/gemini-dispatch.yml https://raw.githubusercontent.com/
7071
curl -o .github/workflows/gemini-review.yml https://raw.githubusercontent.com/google-github-actions/run-gemini-cli/main/examples/workflows/pr-review/gemini-review.yml
7172
```
7273

74+
> **Note:** The `gemini-dispatch.yml` workflow is designed to call multiple
75+
> workflows. If you are only setting up `gemini-review.yml`, you should comment out or
76+
> remove the other jobs in your copy of `gemini-dispatch.yml`.
77+
7378
## Dependencies
7479

7580
This workflow relies on the [gemini-dispatch.yml](../gemini-dispatch/gemini-dispatch.yml) workflow to route requests to the appropriate workflow.

0 commit comments

Comments
 (0)