Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ Use it to perform GitHub pull request reviews, triage issues, perform code analy
- [Quick Start](#quick-start)
- [1. Get a Gemini API Key](#1-get-a-gemini-api-key)
- [2. Add it as a GitHub Secret](#2-add-it-as-a-github-secret)
- [3. Choose a Workflow](#3-choose-a-workflow)
- [4. Try it out!](#4-try-it-out)
- [3. Update your .gitignore](#3-update-your-gitignore)
- [4. Choose a Workflow](#4-choose-a-workflow)
- [5. Try it out!](#5-try-it-out)
- [Workflows](#workflows)
- [Issue Triage](#issue-triage)
- [Pull Request Review](#pull-request-review)
Expand Down Expand Up @@ -52,17 +53,28 @@ Store your API key as a secret named `GEMINI_API_KEY` in your repository:
- Click **New repository secret**
- Name: `GEMINI_API_KEY`, Value: your API key

### 3. Choose a Workflow
### 3. Update your .gitignore
Add the following entries to your `.gitignore` file:

```gitignore
# gemini-cli settings
.gemini/

# GitHub App credentials
gha-creds-*.json
```

### 4. Choose a Workflow
You have two options to set up a workflow:

**Option A: Use setup command (Recommended)**
1. Start the Gemini CLI:
1. Start the Gemini CLI in your terminal:

```shell
gemini
```

2. In the chat interface, type:
2. In Gemini CLI in your terminal, type:

```
/setup-github
Expand All @@ -71,7 +83,7 @@ You have two options to set up a workflow:
**Option B: Manually copy workflows**
1. Copy the pre-built workflows from the [`examples/workflows`](./examples/workflows) directory to your repository's `.github/workflows` directory.

### 4. Try it out!
### 5. Try it out!

**Pull Request Review:**
- Open a pull request in your repository and wait for automatic review
Expand Down
16 changes: 16 additions & 0 deletions examples/workflows/gemini-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ In this guide you will learn how to use the Gemini CLI Assistant via GitHub Acti
- [Overview](#overview)
- [Features](#features)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Setup Methods](#setup-methods)
- [Usage](#usage)
- [Supported Triggers](#supported-triggers)
- [How to Invoke the Gemini CLI Workflow](#how-to-invoke-the-gemini-cli-workflow)
Expand All @@ -32,6 +34,20 @@ Unlike specialized Gemini CLI workflows for [pull request reviews](../pr-review)

For detailed setup instructions, including prerequisites and authentication, please refer to the main [Getting Started](../../../README.md#quick-start) section and [Authentication documentation](../../../docs/authentication.md).

### Prerequisites

Add the following entries to your `.gitignore` file to prevent Gemini CLI artifacts from being committed:

```gitignore
# gemini-cli settings
.gemini/

# GitHub App credentials
gha-creds-*.json
```

### Setup Methods

To use this workflow, you can utilize either of the following methods:
1. Run the `/setup-github` command in Gemini CLI on your terminal to set up workflows for your repository.
2. Copy the `gemini-cli.yml` file into your repository's `.github/workflows` directory:
Expand Down
16 changes: 16 additions & 0 deletions examples/workflows/issue-triage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ This document describes a comprehensive system for triaging GitHub issues using
- [Overview](#overview)
- [Features](#features)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Setup Methods](#setup-methods)
- [Usage](#usage)
- [Supported Triggers](#supported-triggers)
- [Real-Time Issue Triage](#real-time-issue-triage)
Expand Down Expand Up @@ -35,6 +37,20 @@ The Issue Triage workflows provide an automated system for analyzing and categor

For detailed setup instructions, including prerequisites and authentication, please refer to the main [Getting Started](../../../README.md#quick-start) section and [Authentication documentation](../../../docs/authentication.md).

### Prerequisites

Add the following entries to your `.gitignore` file to prevent issue triage artifacts from being committed:

```gitignore
# gemini-cli settings
.gemini/

# GitHub App credentials
gha-creds-*.json
```

### Setup Methods

To implement this issue triage system, you can utilize either of the following methods:
1. Run the `/setup-github` command in Gemini CLI on your terminal to set up workflows for your repository.
2. Copy the workflow files into your repository's `.github/workflows` directory:
Expand Down
16 changes: 16 additions & 0 deletions examples/workflows/pr-review/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ This document explains how to use the Gemini CLI on GitHub to automatically revi
- [Overview](#overview)
- [Features](#features)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Setup Methods](#setup-methods)
- [Usage](#usage)
- [Supported Triggers](#supported-triggers)
- [Interaction Flow](#interaction-flow)
Expand Down Expand Up @@ -44,6 +46,20 @@ The PR Review workflow uses Google's Gemini AI to provide comprehensive code rev

For detailed setup instructions, including prerequisites and authentication, please refer to the main [Getting Started](../../../README.md#quick-start) section and [Authentication documentation](../../../docs/authentication.md).

### Prerequisites

Add the following entries to your `.gitignore` file to prevent PR review artifacts from being committed:

```gitignore
# gemini-cli settings
.gemini/

# GitHub App credentials
gha-creds-*.json
```

### Setup Methods

To use this workflow, you can use either of the following methods:
1. Run the `/setup-github` command in Gemini CLI on your terminal to set up workflows for your repository.
2. Copy the `gemini-pr-review.yml` file into your repository's `.github/workflows` directory:
Expand Down
Loading