Skip to content

DEVELOPER.md

Latest commit

 

History

History
79 lines (54 loc) · 2.84 KB

DEVELOPER.md

File metadata and controls

79 lines (54 loc) · 2.84 KB

DEVELOPER.md

This document provides instructions for setting up your development environment and contributing to the Knowledge Catalog (formerly known as Dataplex) Agent skills 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. Knowledge Catalog: For testing tools, you will need access to an active Knowledge Catalog setup.

Developing the Extension

Running from Local Source

  1. Clone the Repository:

    git clone https://github.com/gemini-cli-extensions/knowledge-catalog.git
cd knowledge-catalog

  2. Install the Extension Locally: Use the Gemini CLI to install the extension from your local directory.

    gemini extensions install .

    The CLI will prompt you to confirm the installation. Accept it to proceed.

  3. Testing Changes: After installation, start the Gemini CLI (gemini). You can now interact with the knowledge-catalog skills to manually test your changes.

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.

All skills are currently tested in the MCP Toolbox GitHub.

The skills themselves are validated using the skills-validate.yml workflow.

Other GitHub Checks

  • License Header Check: A workflow ensures all necessary files contain the proper license header.
  • Conventional Commits: This repository uses Release Please to manage releases. Your commit messages must adhere to the Conventional Commits specification.
  • Dependency Updates: Renovate is configured to automatically create pull requests for dependency updates.

Maintainer Information

Team

The primary maintainers for this repository are defined in the .github/CODEOWNERS file:

  • @gemini-cli-extensions/senseai-eco
  • @gemini-cli-extensions/dataplex-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.