Skip to content

Commit 8023d45

Browse files
docs: regenerate README with new input and outputs
Run `npm run docs` to update autogenerated sections with: - output_to_file input - output_mode and artifacts_dir outputs Ref: #479
1 parent badefcd commit 8023d45

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,10 +190,16 @@ go to the [Gemini Assistant workflow documentation](./examples/workflows/gemini-
190190

191191
- <a name="__input_upload_artifacts"></a><a href="#user-content-__input_upload_artifacts"><code>upload_artifacts</code></a>: _(Optional, default: `false`)_ Whether to upload artifacts to the github action.
192192

193+
- <a name="__input_output_to_file"></a><a href="#user-content-__input_output_to_file"><code>output_to_file</code></a>: _(Optional, default: `false`)_ When true, redirect all output to files and return file paths as step outputs instead of content. Useful when gemini_debug is true to avoid exceeding GitHub Actions output limits.
194+
193195
- <a name="__input_use_pnpm"></a><a href="#user-content-__input_use_pnpm"><code>use_pnpm</code></a>: _(Optional, default: `false`)_ Whether or not to use pnpm instead of npm to install gemini-cli
194196

195197
- <a name="__input_workflow_name"></a><a href="#user-content-__input_workflow_name"><code>workflow_name</code></a>: _(Optional, default: `${{ github.workflow }}`)_ The GitHub workflow name, used for telemetry purposes.
196198

199+
- <a name="__input_github_pr_number"></a><a href="#user-content-__input_github_pr_number"><code>github_pr_number</code></a>: _(Optional, default: `${{ github.event.pull_request.number }}`)_ The Pull Request number the CLI is operating on. Defaults to the event payload.
200+
201+
- <a name="__input_github_issue_number"></a><a href="#user-content-__input_github_issue_number"><code>github_issue_number</code></a>: _(Optional, default: `${{ github.event.issue.number }}`)_ The Issue number (or comma-separated list of issue numbers) the CLI is operating on. Defaults to the event payload.
202+
197203

198204
<!-- END_AUTOGEN_INPUTS -->
199205
<!-- prettier-ignore-end -->
@@ -207,6 +213,10 @@ go to the [Gemini Assistant workflow documentation](./examples/workflows/gemini-
207213

208214
- <a name="__output_error"></a><a href="#user-content-__output_error"><code>error</code></a>: The error output from the Gemini CLI execution, if any.
209215

216+
- <a name="__output_output_mode"></a><a href="#user-content-__output_output_mode"><code>output_mode</code></a>: Output mode used: "content" (default) or "file".
217+
218+
- <a name="__output_artifacts_dir"></a><a href="#user-content-__output_artifacts_dir"><code>artifacts_dir</code></a>: Path to gemini-artifacts/ directory containing stdout.log, stderr.log, telemetry.log.
219+
210220

211221
<!-- END_AUTOGEN_OUTPUTS -->
212222
<!-- prettier-ignore-end -->

0 commit comments

Comments
 (0)