Skip to content

Commit e50be04

Browse files
fix: update README.md for plan-execute workflow added in #465 (#466)
## Changes update the README file for the gemini assistant workflow to include the plan-execute sub workflow. Related #465
1 parent 5b4d318 commit e50be04

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

examples/workflows/gemini-assistant/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,11 @@ To use this workflow, you can utilize either of the following methods:
5858
mkdir -p .github/workflows
5959
curl -o .github/workflows/gemini-dispatch.yml https://raw.githubusercontent.com/google-github-actions/run-gemini-cli/main/examples/workflows/gemini-dispatch/gemini-dispatch.yml
6060
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
61+
curl -o .github/workflows/gemini-plan-execute.yml https://raw.githubusercontent.com/google-github-actions/run-gemini-cli/main/examples/workflows/gemini-assistant/gemini-plan-execute.yml
6162
```
6263

6364
> **Note:** The `gemini-dispatch.yml` workflow is designed to call multiple
64-
> workflows. If you are only setting up `gemini-invoke.yml`, you should comment out or
65+
> workflows. If you are only setting up `gemini-invoke.yml` and `gemini-plan-execute.yml`, you should comment out or
6566
> remove the other jobs in your copy of `gemini-dispatch.yml`.
6667
6768
## Dependencies
@@ -131,14 +132,14 @@ flowchart TD
131132
```
132133

133134
1. **Acknowledge**: The action first posts a brief comment to let the user know the request has been received.
134-
2. **Plan (if needed)**: For requests that may involve code changes or complex actions, the AI will first create a step-by-step plan. It will post this plan as a comment and wait for the user to approve it by replying with `@gemini-cli plan#123 approved`. This ensures the user has full control before any changes are made.
135+
2. **Plan (if needed)**: For requests that may involve code changes or complex actions, the AI will first create a step-by-step plan. It will post this plan as a comment and wait for the user to approve it by replying with `@gemini-cli /approve`. This ensures the user has full control before any changes are made.
135136
3. **Execute**: Once the plan is approved (or if no plan was needed), it runs the Gemini model, providing it with the user's request, repository context, and a set of tools.
136137
4. **Commit (if needed)**: If the AI uses tools to modify files, it will automatically commit and push the changes to the branch.
137138
5. **Respond**: The AI posts a final, comprehensive response as a comment on the issue or pull request.
138139

139140
## Configuration
140141

141-
The Gemini CLI assistant prompt is defined in the `gemini-invoke.toml` file. The action automatically copies this file from `.github/commands/` to `.gemini/commands/` during execution.
142+
The Gemini CLI assistant prompts are defined in the `gemini-invoke.toml` and `gemini-plan-execute.toml` files. The action automatically copies these files from `.github/commands/` to `.gemini/commands/` during execution.
142143

143144
**To customize the assistant prompt:**
144145

@@ -147,9 +148,10 @@ The Gemini CLI assistant prompt is defined in the `gemini-invoke.toml` file. The
147148
```bash
148149
mkdir -p .gemini/commands
149150
curl -o .gemini/commands/gemini-invoke.toml https://raw.githubusercontent.com/google-github-actions/run-gemini-cli/main/examples/workflows/gemini-assistant/gemini-invoke.toml
151+
curl -o .gemini/commands/gemini-plan-execute.toml https://raw.githubusercontent.com/google-github-actions/run-gemini-cli/main/examples/workflows/gemini-assistant/gemini-plan-execute.toml
150152
```
151153

152-
2. Edit `.gemini/commands/gemini-invoke.toml` to customize:
154+
2. Edit `.gemini/commands/gemini-invoke.toml` and `.gemini/commands/gemini-plan-execute.toml` to customize:
153155
- Change its persona or primary function
154156
- Add project-specific guidelines or context
155157
- Instruct it to format its output in a specific way

0 commit comments

Comments
 (0)