Merge branch 'main' into renovate/googleapis-genai-toolbox-0.x

Author: averikitsch

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -38,7 +38,7 @@ body:
         - label: "I've updated to the latest versions"
 
   - type: input
-    id: version
+    id: ex_version
     attributes:
       label: Extension Version
       description: |

DEVELOPER.md

@@ -0,0 +1,111 @@
+# DEVELOPER.md
+
+This document provides instructions for setting up your development environment
+and contributing to the Spanner Gemini CLI Extension project.
+
+## Prerequisites
+
+Before you begin, ensure you have the following:
+
+1.  **Gemini CLI:** Install the Gemini CLI version v0.6.0 or above. Installation
+    instructions can be found on the official Gemini CLI documentation. You can
+    verify your version by running `gemini --version`.
+2.  **Spanner Instance:** For testing data plane tools, you will need access to an active Spanner instance and database.
+
+## Developing the Extension
+
+### Running from Local Source
+
+The core logic for this extension is handled by a pre-built `toolbox` binary. The development process involves installing the extension locally into the Gemini CLI to test changes.
+
+1.  **Clone the Repository:**
+
+    ```bash
+    git clone https://github.com/gemini-cli-extensions/spanner.git
+    cd spanner
+    ```
+
+2.  **Download the Toolbox Binary:** The required version of the `toolbox` binary
+    is specified in `toolbox_version.txt`. Download it for your platform.
+
+    ```bash
+    # Read the required version
+    VERSION=$(cat toolbox_version.txt)
+
+    # Example for macOS/amd64
+    curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v$VERSION/darwin/amd64/toolbox
+    chmod +x toolbox
+    ```
+    Adjust the URL for your operating system (`linux/amd64`, `darwin/arm64`, `windows/amd64`).
+
+3.  **Install the Extension Locally:** Use the Gemini CLI to install the
+    extension from your local directory.
+
+    ```bash
+    gemini extensions install .
+    gemini extensions link .
+    ```
+    The CLI will prompt you to confirm the installation. Accept it to proceed.
+
+4.  **Testing Changes:** After installation, start the Gemini CLI (`gemini`).
+    You can now interact with the `spanner` tools to manually test your changes
+    against your connected database.
+
+## Testing
+
+### Automated Presubmit Checks
+
+A GitHub Actions workflow (`.github/workflows/presubmit-tests.yml`) is triggered
+for every pull request. This workflow primarily verifies that the extension can
+be successfully installed by the Gemini CLI.
+
+Currently, there are no automated unit or integration test suites
+within this repository. All functional testing must be performed manually. All tools
+are currently tested in the [MCP Toolbox GitHub](https://github.com/googleapis/genai-toolbox).
+
+### Other GitHub Checks
+
+*   **License Header Check:** A workflow ensures all necessary files contain the
+    proper license header.
+*   **Conventional Commits:** This repository uses
+    [Release Please](https://github.com/googleapis/release-please) to manage
+    releases. Your commit messages must adhere to the
+    [Conventional Commits](https://www.conventionalcommits.org/) specification.
+*   **Dependency Updates:** [Renovate](https://github.com/apps/forking-renovate)
+    is configured to automatically create pull requests for dependency updates.
+
+## Building the Extension
+
+The "build" process for this extension involves packaging the extension's
+metadata files (`gemini-extension.json`, `spanner.md`, `LICENSE`) along with the
+pre-built `toolbox` binary into platform-specific archives (`.tar.gz` or `.zip`).
+
+This process is handled automatically by the
+[`package-and-upload-assets.yml`](.github/workflows/package-and-upload-assets.yml)
+GitHub Actions workflow when a new release is created. Manual building is not
+required.
+
+## Maintainer Information
+
+### Team
+
+The primary maintainers for this repository are defined in the
+[`.github/CODEOWNERS`](.github/CODEOWNERS) file:
+
+*   `@gemini-cli-extensions/senseai-eco`
+*   `@gemini-cli-extensions/spanner-maintainers`
+
+### Releasing
+
+The release process is automated using `release-please`.
+
+1.  **Release PR:** When commits with conventional commit headers (e.g., `feat:`,
+    `fix:`) are merged into the `main` branch, `release-please` will
+    automatically create or update a "Release PR".
+2.  **Merge Release PR:** A maintainer approves and merges the Release PR. This
+    action triggers `release-please` to create a new GitHub tag and a
+    corresponding GitHub Release.
+3.  **Package and Upload:** The new release triggers the
+    `package-and-upload-assets.yml` workflow. This workflow builds the
+    platform-specific extension archives and uploads them as assets to the
+    GitHub Release.

README.md

@@ -6,20 +6,29 @@
 This Gemini CLI extension provides a set of tools to interact with [Google Cloud Spanner](https://cloud.google.com/spanner/docs) instances. It allows you to manage your databases, execute queries, and explore schemas directly from the [Gemini CLI](https://google-gemini.github.io/gemini-cli/), using natural language prompts.
 
 Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini-cli/blob/main/docs/extensions/index.md).
+> [!IMPORTANT]
+> **We Want Your Feedback!**
+> Please share your thoughts with us by filling out our feedback [form][form]. 
+> Your input is invaluable and helps us improve the project for everyone.
+
+[form]: https://docs.google.com/forms/d/e/1FAIpQLSfEGmLR46iipyNTgwTmIDJqzkAwDPXxbocpXpUbHXydiN1RTw/viewform?usp=pp_url&entry.157487=spanner
 
 ## Why Use the Spanner Extension?
 
 * **Natural Language Management:** Stop wrestling with complex commands. Explore schemas and query data by describing what you want in plain English.
 * **Seamless Workflow:** As a Google-developed extension, it integrates seamlessly into the Gemini CLI environment. No need to constantly switch contexts for common database tasks.
 * **Code Generation:** Accelerate development by asking Gemini to generate data classes and other code snippets based on your table schemas.
 
+
 ## Prerequisites
 
 Before you begin, ensure you have the following:
 
-*   [Gemini CLI](https://github.com/google-gemini/gemini-cli) installed with version **+v0.6.0**.
-*   A Google Cloud project with the **Spanner API** enabled.
-*   IAM Permissions
+* [Gemini CLI](https://github.com/google-gemini/gemini-cli) installed with version **+v0.6.0**.
+* Setup Gemini CLI [Authentication](https://github.com/google-gemini/gemini-cli/tree/main?tab=readme-ov-file#-authentication-options).
+* A Google Cloud project with the **Spanner API** enabled.
+* Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
+* IAM Permissions
     * Cloud Spanner Database Reader (`roles/spanner.databaseReader`)
     * Cloud Spanner Database User (`roles/spanner.databaseUser`)
 
@@ -35,12 +44,12 @@ gemini extensions install https://github.com/gemini-cli-extensions/spanner
 
 ### Configuration
 
-Set the following environment variables before starting the Gemini CLI:
+Set the following environment variables before starting the Gemini CLI. These variables can be loaded from a `.env` file.
 
-*   `SPANNER_PROJECT`: The GCP project ID.
-*   `SPANNER_INSTANCE`: The Spanner instance ID.
-*   `SPANNER_DATABASE`: The Spanner database ID.
-*   `SPANNER_DIALECT`: (Optional) The Spanner database dialect e.g. "googlesql" or "postgresql" (Default: "googlesql")
+* `SPANNER_PROJECT`: The GCP project ID.
+* `SPANNER_INSTANCE`: The Spanner instance ID.
+* `SPANNER_DATABASE`: The Spanner database ID.
+* `SPANNER_DIALECT`: (Optional) The Spanner database dialect e.g. "googlesql" or "postgresql" (Default: "googlesql")
 
 Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
 
@@ -59,12 +68,12 @@ gemini
 
 ## Usage
 
-*   **Explore Schemas and Data:**
+* **Explore Schemas and Data:**
     * "Show me all tables in the 'orders' database."
     * "What are the columns in the 'products' table?"
     * "How many orders were placed in the last 30 days, and what were the top 5 most purchased items?"
 
-*   **Generate Code:**
+* **Generate Code:**
     * "Generate a Python dataclass to represent the 'customers' tab
 
 ## Supported Tools
@@ -79,6 +88,11 @@ Find additional extensions to support your entire software development lifecycle
 
 ## Troubleshooting
 
+Use `gemini --debug` to enable debugging.
+
+Common issues:
+
+* "failed to find default credentials: google: could not find default credentials.": Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment. See [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/external/set-up-adc) for more information.
 * "✖ Error during discovery for server: MCP error -32000: Connection closed": The database connection has not been established. Ensure your configuration is set via environment variables.
-* "✖ MCP ERROR: Error: spawn /Users/<USER>/.gemini/extensions/spanner/toolbox ENOENT": The Toolbox binary did not download correctly. Ensure you are using Gemini CLI v0.6.0+.
+* "✖ MCP ERROR: Error: spawn /Users/USER/.gemini/extensions/spanner/toolbox ENOENT": The Toolbox binary did not download correctly. Ensure you are using Gemini CLI v0.6.0+.
 * "cannot execute binary file": The Toolbox binary did not download correctly. Ensure the correct binary for your OS/Architecture has been downloaded. See [Installing the server](https://googleapis.github.io/genai-toolbox/getting-started/introduction/#installing-the-server) for more information.