Skip to content

Commit 09f4ced

Browse files
authored
chore: add developer instructions (#38)
1 parent 34d7129 commit 09f4ced

File tree

1 file changed

+111
-0
lines changed

1 file changed

+111
-0
lines changed

DEVELOPER.md

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# DEVELOPER.md
2+
3+
This document provides instructions for setting up your development environment
4+
and contributing to the PostgreSQL Gemini CLI Extension project.
5+
6+
## Prerequisites
7+
8+
Before you begin, ensure you have the following:
9+
10+
1. **Gemini CLI:** Install the Gemini CLI version v0.6.0 or above. Installation
11+
instructions can be found on the official Gemini CLI documentation. You can
12+
verify your version by running `gemini --version`.
13+
2. **PostgreSQL Instance:** For testing data plane tools, you will need access to an active PostgreSQL instance and database.
14+
15+
## Developing the Extension
16+
17+
### Running from Local Source
18+
19+
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.
20+
21+
1. **Clone the Repository:**
22+
23+
```bash
24+
git clone https://github.com/gemini-cli-extensions/postgres.git
25+
cd postgres
26+
```
27+
28+
2. **Download the Toolbox Binary:** The required version of the `toolbox` binary
29+
is specified in `toolbox_version.txt`. Download it for your platform.
30+
31+
```bash
32+
# Read the required version
33+
VERSION=$(cat toolbox_version.txt)
34+
35+
# Example for macOS/amd64
36+
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v$VERSION/darwin/amd64/toolbox
37+
chmod +x toolbox
38+
```
39+
Adjust the URL for your operating system (`linux/amd64`, `darwin/arm64`, `windows/amd64`).
40+
41+
3. **Install the Extension Locally:** Use the Gemini CLI to install the
42+
extension from your local directory.
43+
44+
```bash
45+
gemini extensions install .
46+
gemini extensions link .
47+
```
48+
The CLI will prompt you to confirm the installation. Accept it to proceed.
49+
50+
4. **Testing Changes:** After installation, start the Gemini CLI (`gemini`).
51+
You can now interact with the `postgres` tools to manually test your changes
52+
against your connected database.
53+
54+
## Testing
55+
56+
### Automated Presubmit Checks
57+
58+
A GitHub Actions workflow (`.github/workflows/presubmit-tests.yml`) is triggered
59+
for every pull request. This workflow primarily verifies that the extension can
60+
be successfully installed by the Gemini CLI.
61+
62+
Currently, there are no automated unit or integration test suites
63+
within this repository. All functional testing must be performed manually. All tools
64+
are currently tested in the [MCP Toolbox GitHub](https://github.com/googleapis/genai-toolbox).
65+
66+
### Other GitHub Checks
67+
68+
* **License Header Check:** A workflow ensures all necessary files contain the
69+
proper license header.
70+
* **Conventional Commits:** This repository uses
71+
[Release Please](https://github.com/googleapis/release-please) to manage
72+
releases. Your commit messages must adhere to the
73+
[Conventional Commits](https://www.conventionalcommits.org/) specification.
74+
* **Dependency Updates:** [Renovate](https://github.com/apps/forking-renovate)
75+
is configured to automatically create pull requests for dependency updates.
76+
77+
## Building the Extension
78+
79+
The "build" process for this extension involves packaging the extension's
80+
metadata files (`gemini-extension.json`, `postgres.md`, `LICENSE`) along with the
81+
pre-built `toolbox` binary into platform-specific archives (`.tar.gz` or `.zip`).
82+
83+
This process is handled automatically by the
84+
[`package-and-upload-assets.yml`](.github/workflows/package-and-upload-assets.yml)
85+
GitHub Actions workflow when a new release is created. Manual building is not
86+
required.
87+
88+
## Maintainer Information
89+
90+
### Team
91+
92+
The primary maintainers for this repository are defined in the
93+
[`.github/CODEOWNERS`](.github/CODEOWNERS) file:
94+
95+
* `@gemini-cli-extensions/senseai-eco`
96+
* `@gemini-cli-extensions/postgres-maintainers`
97+
98+
### Releasing
99+
100+
The release process is automated using `release-please`.
101+
102+
1. **Release PR:** When commits with conventional commit headers (e.g., `feat:`,
103+
`fix:`) are merged into the `main` branch, `release-please` will
104+
automatically create or update a "Release PR".
105+
2. **Merge Release PR:** A maintainer approves and merges the Release PR. This
106+
action triggers `release-please` to create a new GitHub tag and a
107+
corresponding GitHub Release.
108+
3. **Package and Upload:** The new release triggers the
109+
`package-and-upload-assets.yml` workflow. This workflow builds the
110+
platform-specific extension archives and uploads them as assets to the
111+
GitHub Release.

0 commit comments

Comments
 (0)