Skip to content
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.

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

feat: Migrate from the "Runner" to the "SDK" approach (main set of changes) #96

Merged
merged 65 commits into from
Mar 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
65 commits
Select commit Hold shift + click to select a range
7df9547
Move everything into runner (stable)
machulav Feb 21, 2024
2723c02
Move types (stable)
machulav Feb 21, 2024
6309d37
Update
machulav Feb 24, 2024
e099eb0
Update
machulav Feb 24, 2024
1e23bda
Update
machulav Feb 24, 2024
97d43f9
Upd
machulav Feb 24, 2024
80f1836
Update
machulav Feb 25, 2024
b84e23c
Update
machulav Feb 25, 2024
4babe22
Deprecate lodash
machulav Feb 25, 2024
5a9981c
Update
machulav Feb 25, 2024
7b91197
Update
machulav Feb 25, 2024
0eac80d
Move SDK to packages
machulav Feb 25, 2024
98a0f7f
Update
machulav Feb 25, 2024
9b878b5
Add OpenAPI schema
machulav Feb 26, 2024
a9675cb
Update
machulav Feb 26, 2024
cbc4842
Upd
machulav Feb 26, 2024
f8aae7a
Upd
machulav Feb 26, 2024
8d1ea53
Update
machulav Feb 26, 2024
9be3efb
Update
machulav Feb 26, 2024
45556e2
Fix linter
machulav Feb 26, 2024
af22c47
Upd
machulav Feb 26, 2024
5fc86d4
Upd
machulav Feb 26, 2024
23548f2
Update
machulav Feb 26, 2024
38d0e35
Upd
machulav Feb 26, 2024
2e87cd8
Update
machulav Feb 26, 2024
71ffc73
Upd
machulav Feb 26, 2024
15b6b51
Update
machulav Feb 26, 2024
d3ec7db
Add home page
machulav Feb 26, 2024
a602727
Update
machulav Feb 26, 2024
0e111d1
Update
machulav Feb 27, 2024
3acd4fa
Update
machulav Feb 28, 2024
994895a
Update
machulav Feb 28, 2024
36fb0da
Upd
machulav Feb 28, 2024
670b9c8
Update
machulav Feb 28, 2024
2b2fb95
Update
machulav Feb 29, 2024
3e02e14
Update tests
machulav Feb 29, 2024
26f0e03
Upd
machulav Feb 29, 2024
7aa01a9
Upd
machulav Feb 29, 2024
26b6353
Upd
machulav Mar 7, 2024
a8e6d78
Update tests
machulav Mar 8, 2024
ed728e5
Update api
machulav Mar 8, 2024
705d7a0
Update
machulav Mar 21, 2024
50df8d0
Update main page
machulav Mar 22, 2024
2a9b042
Update
machulav Mar 22, 2024
f7d71a0
Update config
machulav Mar 24, 2024
5ed6162
Update automation
machulav Mar 25, 2024
db1d0d5
Update
machulav Mar 27, 2024
514a9cd
Update
machulav Mar 27, 2024
83aa219
Update
machulav Mar 27, 2024
becadd9
Update
machulav Mar 27, 2024
1b0c41c
Update
machulav Mar 27, 2024
af8c88b
Update
machulav Mar 27, 2024
a49450a
Update
machulav Mar 28, 2024
d0ee9a7
Update
machulav Mar 28, 2024
74f43db
Add release workflow
machulav Mar 28, 2024
c102446
Update workflow
machulav Mar 28, 2024
dcb8cf5
fix: add job name
machulav Mar 28, 2024
f25fd60
chore: update semantic-release config
machulav Mar 28, 2024
f35943a
chore: update release workflow
machulav Mar 28, 2024
b5b676d
chore: fix linter config
machulav Mar 28, 2024
bf9b0b8
chore: update release workflow
machulav Mar 28, 2024
f1a11ac
chore: update release workflow
machulav Mar 28, 2024
c7094d6
Merge branch 'beta' into sdk-v2
machulav Mar 28, 2024
4d40eff
Update
machulav Mar 28, 2024
312b6bf
Merge branch 'sdk-v2' of github.com:connery-io/connery into sdk-v2
machulav Mar 28, 2024
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
8 changes: 0 additions & 8 deletions .changeset/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions .changeset/config.json

This file was deleted.

19 changes: 0 additions & 19 deletions .devcontainer/create-dot-env.sh

This file was deleted.

14 changes: 1 addition & 13 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,12 @@
"name": "Connery",
"image": "mcr.microsoft.com/devcontainers/typescript-node",
"postStartCommand": "./.devcontainer/post-start-commands.sh",
"forwardPorts": [4040, 4201, 4202, 9229],
"forwardPorts": [4202],
"portsAttributes": {
"4040": {
"label": "ngrok",
"onAutoForward": "silent"
},
"4201": {
"label": "Runner",
"onAutoForward": "silent"
},
"4202": {
"label": "Docs",
"onAutoForward": "silent"
},
"9229": {
"label": "Runner Debugger",
"onAutoForward": "silent"
},
"default": {
"label": "Application",
"onAutoForward": "silent"
Expand Down
5 changes: 1 addition & 4 deletions .devcontainer/post-start-commands.sh
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
#!/bin/bash

# Create .env file
./.devcontainer/create-dot-env.sh

# Install dependencies
yarn install --prefer-offline
yarn install

# Build project
yarn run build
23 changes: 0 additions & 23 deletions .env.example

This file was deleted.

76 changes: 76 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
name: Release

on:
push:
branches:
- main
- beta

jobs:
format:
name: Format
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
with:
node-version: "20"

- run: yarn install
working-directory: ./packages/connery

- run: yarn run format:check
working-directory: ./packages/connery

lint:
name: Lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
with:
node-version: "20"

- run: yarn install
working-directory: ./packages/connery

- run: yarn run lint
working-directory: ./packages/connery

test:
name: Test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
with:
node-version: "20"

- run: yarn install
working-directory: ./packages/connery

- run: yarn run test
working-directory: ./packages/connery

release:
name: Release
runs-on: ubuntu-latest
needs: [format, lint, test]
steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
with:
node-version: "20"

- run: yarn install
working-directory: ./packages/connery

- run: npx semantic-release
working-directory: ./packages/connery
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
17 changes: 0 additions & 17 deletions .vscode/launch.json

This file was deleted.

40 changes: 30 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,31 @@
# Connery - Plugin infrastructure for AI
# The open-source SDK for AI plugins and actions development

[![Release](https://img.shields.io/github/v/release/connery-io/connery?color=74C649&label=Release)](https://github.com/connery-io/connery/releases)
[![License](https://img.shields.io/github/license/connery-io/connery?color=74C649&label=License)](https://github.com/connery-io/connery/blob/main/LICENSE)
[![Open in GitHub Codespaces](https://img.shields.io/badge/Open%20in%20GitHub%20Codespaces-black?logo=github)](https://github.com/codespaces/new/connery-io/connery?quickstart=1)
[![Open in Dev Containers](https://img.shields.io/badge/Open%20in%20Dev%20Container-blue?logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/connery-io/connery)

## 🚀 Quickstart

1. Initialize a new AI plugin with a sample action.

```bash
npx connery dev init
```

2. Install the dependencies.

```bash
npm install
```

3. Run the plugin.

```bash
npm start
```

4. Explore the plugin in your browser at [http://localhost:4201](http://localhost:4201).

5. [Learn how to use the plugin and its actions.](https://docs.connery.io/docs/runner/quick-start/)

## 🤔 What is this?

Expand Down Expand Up @@ -152,13 +174,11 @@ You can reach us via the following channels:

This is a monorepo that contains the following components:

| Name | Path | Description |
| ------ | -------------------- | --------------------------------------------------------------------------------------------------------------- |
| Runner | `./apps/runner` | The core of Connery that knows how to handle plugins, run actions, and provide a standardized API as an output. |
| Docs | `./apps/docs` | The [documentation](https://docs.connery.io/) website. |
| CLI | `./packages/connery` | [`connery`](https://www.npmjs.com/package/connery) CLI package for plugin development. |
| SDK | `./packages/sdk` | [`@connery-io/sdk`](https://www.npmjs.com/package/@connery-io/sdk) SDK package for plugin development. |
| Lib | `./packages/lib` | Shared library for the runner and the CLI. |
| Name | Path | Description |
| ---- | ---------------- | ------------------------------------------------------------------------------------------------------ |
| Docs | `./apps/docs` | The [documentation](https://docs.connery.io/) website. |
| CLI | `./packages/cli` | [`connery`](https://www.npmjs.com/package/connery) CLI package for plugin development. |
| SDK | `./packages/sdk` | [`@connery-io/sdk`](https://www.npmjs.com/package/@connery-io/sdk) SDK package for plugin development. |

## 👨‍💻 Contributing

Expand Down
25 changes: 0 additions & 25 deletions apps/runner/.eslintrc.js

This file was deleted.

2 changes: 0 additions & 2 deletions apps/runner/.gitignore

This file was deleted.

7 changes: 0 additions & 7 deletions apps/runner/.prettierrc

This file was deleted.

24 changes: 0 additions & 24 deletions apps/runner/Dockerfile

This file was deleted.

55 changes: 0 additions & 55 deletions apps/runner/connery-runner.config.ts

This file was deleted.

5 changes: 0 additions & 5 deletions apps/runner/nest-cli.json

This file was deleted.

Loading