Skip to content

feat: connector development server #534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: connector development server #534

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
63 changes: 63 additions & 0 deletions tools/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Internal Development Support Tools

This directory contains a series of tools helping the develoment and build process.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix typo and remove stray trailing line.

  • "develoment" → "development".
  • Remove the dangling "64" at EOF.
-This directory contains a series of tools helping the develoment and build process.
+This directory contains a series of tools helping the development and build process.
-
-64

Also applies to: 64-64

🧰 Tools
🪛 LanguageTool

[grammar] ~3-~3: Ensure spelling is correct
Context: ... contains a series of tools helping the develoment and build process. ## Core Build Tools...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents 
In tools/README.md around line 3 (and also at line 64), fix the misspelling
"develoment" to "development" and remove the stray trailing "64" at EOF; update
the sentence to read "This directory contains a series of tools helping the
development and build process." and delete the dangling "64" so the file ends
cleanly without extraneous characters.


## Core Build Tools

### `compile-plugins/`
**Shell script that auto-generates connector import list**
- Scans `internal/connectors/plugins/public/` directory
- Creates `list.go` with blank imports for all connectors
- Run: `just compile-plugins`

### `compile-configs/`
**Go tool that generates OpenAPI schemas from connector configs**
- Reads `config.go` files from each connector
- Parses struct tags to generate OpenAPI YAML
- Outputs: `openapi/v3/v3-connectors-config.yaml`
- Run: `just compile-connector-configs`

### `compile-capabilities/`
**Go tool that extracts connector capabilities**
- Reads connector capabilities from registry
- Generates JSON mapping of provider → capabilities
- Outputs: `docs/other/connector-capabilities.json`
- Run: `just compile-connector-capabilities`

## Development Tools

### `connector-dev-server/`
**Simple dev server for testing individual connectors**
- Imports single connector for isolated testing
- Provides basic HTTP API for connector operations
- Useful for development and debugging
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add how to run it


### `connector-template/`
**Code generator for new connectors**
- Generates boilerplate connector structure
- Uses Go templates to create all required files
- Run: `./tools/connector-template/connector-template.sh <name>`

## Maintenance Tools

### `list-and-delete-temporal-schedules/`
**Temporal schedule management**
- Lists all Temporal schedules
- Can delete specific schedules
- Useful for cleanup and maintenance

### `list-and-delete-temporal-workflows/`
**Temporal workflow management**
- Lists all Temporal workflows
- Can delete specific workflows
- Useful for cleanup and maintenance

## Usage

All tools are orchestrated via the main `Justfile`:

```bash
just pre-commit # Runs all build tools
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No changes were made to the Justfile, so I don't think this is the case?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this shouldn't run all tools right?

just openapi # Generates API documentation
just pc # Alias for pre-commit
```
Loading
Loading