feat(docs): improve manual setup instructions for workflows #263
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
🤖 Hi @jerop, I've received your request, and I'm working on it now! You can track my progress in the logs for more details. |
There was a problem hiding this comment.
📋 Review Summary
This pull request adds a helpful note to the documentation for manually setting up workflows, which will prevent users from encountering errors. The core idea is solid, but the implementation has a copy-paste error in two of the files.
🔍 General Feedback
- The added note in
gemini-assistant/README.mdandissue-triage/README.mdincorrectly refers to "PR Review". I have left specific suggestions to correct this. - The change in
pr-review/README.mdis correct.
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
a6ba1bf to
ce918c7
Compare
Contributor
Author
|
@gemini-cli /review |
|
🤖 Hi @jerop, I've received your request, and I'm working on it now! You can track my progress in the logs for more details. |
There was a problem hiding this comment.
📋 Review Summary
This pull request improves the documentation for manually setting up workflows by adding a note to comment out unused jobs in gemini-dispatch.yml. This is a good improvement that will help users avoid errors.
🔍 General Feedback
- The change is applied consistently across all three relevant README files.
- The added note is helpful and addresses a potential point of confusion for users.
gsquared94
approved these changes
Sep 8, 2025
Merged
google-github-actions-bot
added a commit
that referenced
this pull request
Oct 9, 2025
## What's Changed * chore: script to generate examples by @leehagoodjames in #244 * chore: update readme to state user must copy gemini-dispatch.yml by @leehagoodjames in #249 * Relax node requirement and bump actions-utils by @sethvargo in #253 * feat: support /fix slash command and workflow by @leehagoodjames in #190 * feat(docs): improve manual setup instructions for workflows by @jerop in #263 * feat: improve action input descriptions by @jerop in #264 * fix: enforce COMMENT event type for submit_pending_pull_request_review by @jerop in #271 * docs: add fork support documentation for PR review workflow by @jerop in #268 * feat(action): add support for preview and nightly versions by @jerop in #281 * feat(workflows): add gemini_cli_version to all workflows by @jerop in #279 * feat: migrate to new Gemini CLI configuration format by @jerop in #284 * feat: clean up temp fix for empty API key by @jerop in #285 * Sort inputs alphabetically in action.yml by @jerop in #286 * chore: organize workflow inputs alphabetically and add missing parameters by @jerop in #288 * feat: add auth input validation by @jerop in #289 * fix(action): correct quoting in workflow expressions by @jerop in #293 * fix(validation): improve validation error messages by @jerop in #297 * fix(validate-inputs): surface errors in logs, annotation, and step summary by @jerop in #299 * feat(validate-inputs): downgrade validation failures to warnings by @jerop in #300 * fix(validate-inputs): use env-based bash shebang for portability by @jerop in #303 * feat: simplify input validation logic by @jerop in #304 * fix(action): correct input validation script behavior by @jerop in #309 * feat: add command substitution security warning by @jerop in #306 * fix(triage): correct duplicate step numbering in workflow by @aladh in #331 * feat: Optionally install extensions by @CallumHYoung in #329 * docs(extensions): add documentation for extensions by @jerop in #340 * chore(workflows): Apply formatting and fix example prompt by @jerop in #339 * refactor(workflows): improve prompts to use env vars directly by @jerop in #342 * fix(review): Remove --source argument to match CLI 8.0 release by @CallumHYoung in #347 ## New Contributors * @aladh made their first contribution in #331 * @CallumHYoung made their first contribution in #329 **Full Changelog**: v0.1.12...v0.1.13
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
gemini-dispatch.ymlworkflow is designed to call other workflows likegemini-review.yml,gemini-triage.yml, andgemini-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 ofgemini-dispatch.yml.This prevents errors and makes the manual setup process more robust.
Fixes #256