feat: reorganize examples and docs into workflows (#20)

This commit reorganizes the project structure by moving the `examples`
and `docs` directories into a new `workflows` directory. This change
improves the organization of the project and makes it easier to find and
contribute to the available workflows.

The `workflows` directory now contains a `README.md` file that provides
an overview of the available workflows and encourages community
contributions.

The main `README.md` file has been updated to reflect the new directory
structure.

Author: jerop

README.md

@@ -18,9 +18,10 @@ Cloud product, please contact [Google Cloud support].**
     - [Outputs](#outputs)
     - [Environment Variables](#environment-variables)
     - [Secrets](#secrets)
-  - [Usage and Examples](#usage-and-examples)
-  - [Issue Triage](#issue-triage)
-  - [Pull Request Review](#pull-request-review)
+  - [Workflows](#workflows)
+    - [Issue Triage](#issue-triage)
+    - [Pull Request Review](#pull-request-review)
+    - [Generic Gemini CLI](#generic-gemini-cli)
   - [Authentication](#authentication)
   - [Observability with OpenTelemetry](#observability-with-opentelemetry)
     - [OpenTelemetry in Google Cloud](#opentelemetry-in-google-cloud)
@@ -99,32 +100,39 @@ To add a secret, go to your repository's **Settings > Secrets and variables >
 Actions > New repository secret**. For more information, see the
 [official GitHub documentation on creating and using encrypted secrets][secrets].
 
-## Usage and Examples
+## Workflows
 
 To use this action, create a workflow file in your repository (e.g.,
 `.github/workflows/gemini.yml`).
 
 The best way to get started is to copy one of the pre-built workflows from the
-[`/examples`](./examples) directory into your project's `.github/workflows`
+[`/workflows`](./workflows) directory into your project's `.github/workflows`
 folder and customize it.
 
 See the sections below for specific examples.
 
-## Issue Triage
+### Issue Triage
 
 This action can be used to triage GitHub issues automatically or on a schedule.
 For a detailed guide on how to set up the issue triage system, please see the
-[**Issue Triage documentation**](./docs/issue-triage.md).
+[documentation](./workflows/issue-triage).
 
-## Pull Request Review
+### Pull Request Review
 
 This action can be used to automatically review pull requests when they are
 opened. Additionally, users with `OWNER`, `MEMBER`, or `COLLABORATOR`
 permissions can trigger a review by commenting `@gemini-cli /review` in a pull
 request.
 
 For a detailed guide on how to set up the pull request review system, please see
-the [**Pull Request Review documentation**](./docs/pr-review.md).
+the [documentation](./workflows/pr-review).
+
+### Generic Gemini CLI
+
+This action can be used to invoke a general-purpose, conversational AI assistant
+that can be invoked within pull requests and issues to perform a wide range of
+tasks. For a detailed guide on how to set up the Gemini CLI, please see the
+[documentation](./workflows/gemini-cli).
 
 ## Authentication
 

workflows/README.md

@@ -0,0 +1,21 @@
+# Gemini CLI Workflows
+
+This directory contains a collection of example workflows that demonstrate how to use the [Google Gemini CLI GitHub Action](https://github.com/google-github-actions/run-gemini-cli). These workflows are designed to be reusable and customizable for your own projects.
+
+## Available Workflows
+
+*   **[Issue Triage](./issue-triage)**: Automatically triage GitHub issues using Gemini. This workflow can be configured to run on a schedule or be triggered by issue events.
+*   **[Pull Request Review](./pr-review)**: Automatically review pull requests using Gemini. This workflow can be triggered by pull request events and provides a comprehensive review of the changes.
+*   **[Gemini CLI](./gemini-cli)**: A general-purpose, conversational AI assistant that can be invoked within pull requests and issues to perform a wide range of tasks.
+
+## Contributing
+
+We encourage you to contribute to this collection of workflows! If you have a workflow that you would like to share with the community, please open a pull request.
+
+When contributing, please follow these guidelines. For more information on contributing to the project as a whole, please see the [CONTRIBUTING.md](../../CONTRIBUTING.md) file.
+
+*   Create a new directory for your workflow.
+*   Include a `README.md` file that explains how to use your workflow.
+*   Add your workflow to the list of available workflows in this `README.md` file.
+
+We look forward to seeing what you build!

docs/gemini-cli.md workflows/gemini-cli/README.mddocs/gemini-cli.md renamed to workflows/gemini-cli/README.md

@@ -49,7 +49,13 @@ When invoked with `@gemini-cli`, the assistant uses a customizable set of tools
 
 ### Workflow File
 
-Copy the example workflow file from `examples/gemini-cli.yml` to `.github/workflows/gemini-cli.yml` in your repository.
+Create the necessary directories and download the example workflow file into your repository's `.github/workflows` directory.
+
+```bash
+mkdir -p .github/workflows
+curl -o .github/workflows/gemini-cli.yml https://raw.githubusercontent.com/google-github-actions/run-gemini-cli/main/workflows/gemini-cli/gemini-cli.yml
+```
+Alternatively, you can manually copy the contents of the workflow file from this repository into the corresponding file in your own repository.
 
 ## Usage
 

examples/gemini-cli.yml workflows/gemini-cli/gemini-cli.ymlexamples/gemini-cli.yml renamed to workflows/gemini-cli/gemini-cli.yml

@@ -165,7 +165,7 @@ jobs:
             --repo "${REPOSITORY}"
 
       - name: 'Run Gemini'
-        uses: './'
+        uses: 'google-github-actions/run-gemini-cli@main'
         env:
           GITHUB_TOKEN: '${{ steps.generate_token.outputs.token || secrets.GITHUB_TOKEN }}'
           REPOSITORY: '${{ github.repository }}'

docs/issue-triage.md workflows/issue-triage/README.mddocs/issue-triage.md renamed to workflows/issue-triage/README.md

@@ -49,10 +49,15 @@ The two workflows work together to ensure that all new and existing issues are t
 
 To implement this issue triage system in your repository, you will need to do the following:
 
-1.  **Create the Workflows**: Copy the example workflow files into your repository's `.github/workflows` directory.
+1.  **Create the Workflow Files**: Create the necessary directories and download the example workflow files into `.github/workflows` directory in your repository.
 
-    *   `examples/gemini-issue-automated-triage.yml`
-    *   `examples/gemini-issue-scheduled-triage.yml`
+```bash
+mkdir -p .github/workflows
+curl -o .github/workflows/gemini-issue-automated-triage.yml https://raw.githubusercontent.com/google-github-actions/run-gemini-cli/main/workflows/issue-triage/gemini-issue-automated-triage.yml
+curl -o .github/workflows/gemini-issue-scheduled-triage.yml https://raw.githubusercontent.com/google-github-actions/run-gemini-cli/main/workflows/issue-triage/gemini-issue-scheduled-triage.yml
+```
+
+Alternatively, you can manually copy the contents of the workflow files from this repository into the corresponding files in your own repository.
 
 2.  **Configure Secrets**: The workflows require secrets for authentication. You will need to create the following secrets in your repository's settings:
 
@@ -66,8 +71,8 @@ To implement this issue triage system in your repository, you will need to do th
 
 ### Real-Time Issue Triage
 
-This workflow is defined in `examples/gemini-issue-automated-triage.yml` and is triggered when an issue is opened or reopened. It uses the Gemini CLI to analyze the issue and apply relevant labels.
+This workflow is defined in `workflows/issue-triage/gemini-issue-automated-triage.yml` and is triggered when an issue is opened or reopened. It uses the Gemini CLI to analyze the issue and apply relevant labels.
 
 ### Scheduled Issue Triage
 
-This workflow is defined in `examples/gemini-issue-scheduled-triage.yml` and runs on a schedule (e.g., every hour). It finds any issues that have no labels or have the `status/needs-triage` label and then uses the Gemini CLI to triage them. This workflow can also be manually triggered.
+This workflow is defined in `workflows/issue-triage/gemini-issue-scheduled-triage.yml` and runs on a schedule (e.g., every hour). It finds any issues that have no labels or have the `status/needs-triage` label and then uses the Gemini CLI to triage them. This workflow can also be manually triggered.

…amples/gemini-issue-automated-triage.yml …triage/gemini-issue-automated-triage.ymlexamples/gemini-issue-automated-triage.yml renamed to workflows/issue-triage/gemini-issue-automated-triage.yml examples/gemini-issue-automated-triage.yml renamed to workflows/issue-triage/gemini-issue-automated-triage.yml

@@ -55,7 +55,13 @@ The PR Review workflow uses Google's Gemini AI to provide comprehensive code rev
 
 ### Workflow File
 
-Copy the workflow file to `.github/workflows/gemini-pr-review.yml` in your repository. The workflow is already configured and ready to use.
+Create the necessary directories and download the example workflow file into your repository's `.github/workflows` directory.
+
+```bash
+mkdir -p .github/workflows
+curl -o .github/workflows/gemini-pr-review.yml https://raw.githubusercontent.com/google-github-actions/run-gemini-cli/main/workflows/pr-review/gemini-pr-review.yml
+```
+Alternatively, you can manually copy the contents of the workflow file from this repository into the corresponding file in your own repository.
 
 ## Usage