Github integration (#10)

* github integration

* adding readme

github/README.md

@@ -0,0 +1,121 @@
+# @restackio/integrations-github
+
+This package provides integration with Github, allowing you to create and publish releases programmatically using the Github API.
+
+## Installation
+
+To install the package, use npm or yarn:
+
+```bash
+npm install @restackio/integrations-github
+```
+
+## Usage
+
+Make sure to create an access token on your github account and set the token as environment variabled named `GITHUB_AUTH_TOKEN`
+
+### Setting up the Github service
+
+To use the Github integration, you need to set up the Github service:
+
+```typescript
+// services.ts
+import Restack from "@restackio/ai";
+import { githubService } from "@restackio/integrations-github";
+
+export async function services() {
+  const client = new Restack();
+  githubService({ client }).catch((err) => {
+    console.error("Error starting Github service:", err);
+  });
+}
+
+services().catch((err) => {
+  console.error("Error running services:", err);
+});
+```
+
+### Creating a release
+
+To create a release for a provided repository on Github:
+
+```typescript
+/// workflows/createRelease.ts
+
+import { log, step } from "@restackio/ai/workflow";
+import { githubTaskQueue } from "@restackio/integrations-github/taskQueue";
+import * as githubFunctions from "@restackio/integrations-github/functions";
+
+import * as functions from "../functions";
+
+export async function createReleaseWorkflow({
+  owner,
+  repo,
+  tagName,
+  releaseName,
+  releaseBody,
+  branch,
+}: {
+  owner: string;
+  repo: string;
+  tagName: string;
+  releaseName: string;
+  releaseBody: string;
+  branch?: string;
+}) {
+  const createdRelease = await step<typeof githubFunctions>({
+    taskQueue: githubTaskQueue,
+  }).createRelease({
+    owner,
+    repo,
+    tagName,
+    releaseName,
+    releaseBody,
+    branch,
+  });
+
+  return createdRelease;
+}
+```
+
+### Publishing a release
+
+To mark the release as published on Github:
+
+```typescript
+/// workflows/publishRelease.ts
+
+import { log, step } from "@restackio/ai/workflow";
+import { githubTaskQueue } from "@restackio/integrations-github/taskQueue";
+import * as githubFunctions from "@restackio/integrations-github/functions";
+
+import * as functions from "../functions";
+
+export async function publishReleaseWorkflow({
+  owner,
+  repo,
+  id,
+}: {
+  owner: string;
+  repo: string;
+  id: number;
+}) {
+  const publishedRelease = await step<typeof githubFunctions>({
+    taskQueue: githubTaskQueue,
+  }).publishRelease({
+    owner,
+    repo,
+    id.
+  });
+
+  return publishedRelease;
+}
+```
+
+## Configuration
+
+The Github client is configured using an access token. You can either pass the API key directly to the functions or set it as an environment variable:
+
+```bash
+GITHUB_AUTH_TOKEN=your-access-token
+```

github/functions/createRelease.ts

@@ -0,0 +1,44 @@
+import { githubClient } from "../utils/client.js";
+
+export async function createRelease({
+  owner,
+  repo,
+  tagName,
+  releaseName,
+  releaseBody,
+  branch,
+  isDraft = false,
+}: {
+  owner: string;
+  repo: string;
+  tagName: string;
+  releaseName: string;
+  releaseBody: string;
+  branch?: string;
+  isDraft?: boolean;
+}) {
+  try {
+    const { octokit } = await githubClient();
+    const { data } = await octokit.rest.repos.createRelease({
+      owner,
+      repo,
+      tag_name: tagName,
+      name: releaseName,
+      body: releaseBody,
+      draft: isDraft,
+      generate_release_notes: true,
+      ...(branch && { target_commitish: branch }),
+    });
+
+    return {
+      name: data.name,
+      tag_name: data.tag_name,
+      draft: data.draft,
+      published_at: data.published_at,
+      html_url: data.html_url,
+      id: data.id,
+    };
+  } catch (error) {
+    throw new Error(`Error while creating release: ${error}`);
+  }
+}

github/functions/getReleases.ts

@@ -0,0 +1,21 @@
+import { githubClient } from "../utils/client.js";
+
+export async function getReleases({
+  owner,
+  repo,
+}: {
+  owner: string;
+  repo: string;
+}) {
+  try {
+    const { octokit } = await githubClient();
+    const { data } = await octokit.rest.repos.listReleases({
+      owner,
+      repo,
+    });
+
+    return data;
+  } catch (error) {
+    throw new Error(`Error while fetching releases: ${error}`);
+  }
+}

github/functions/index.ts

@@ -0,0 +1,3 @@
+export * from "./createRelease.js";
+export * from "./getReleases.js";
+export * from "./publishRelease.js";

github/functions/publishRelease.ts

@@ -0,0 +1,32 @@
+import { githubClient } from "../utils/client.js";
+
+export async function publishRelease({
+  owner,
+  repo,
+  id,
+}: {
+  owner: string;
+  repo: string;
+  id: number;
+}) {
+  try {
+    const { octokit } = await githubClient();
+    const { data } = await octokit.rest.repos.updateRelease({
+      owner,
+      repo,
+      release_id: id,
+      draft: false,
+    });
+
+    return {
+      name: data.name,
+      tag_name: data.tag_name,
+      draft: data.draft,
+      published_at: data.published_at,
+      html_url: data.html_url,
+      id: data.id,
+    };
+  } catch (error) {
+    throw new Error(`Error while updating release: ${error}`);
+  }
+}

github/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@restackio/integrations-github",
+  "version": "1.0.0",
+  "main": "dist/service.js",
+  "types": "dist/service.d.ts",
+  "scripts": {
+    "start.watch": "nodemon ./service.ts",
+    "dev": "pnpm start.watch",
+    "clean": "rm -rf dist",
+    "build": "npm run clean && tsc"
+  },
+  "dependencies": {
+    "@octokit/auth-token": "^5.1.1",
+    "octokit": "^4.0.2"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/service.js",
+      "require": "./dist/service.js",
+      "types": "./dist/service.d.ts"
+    },
+    "./taskQueue": {
+      "import": "./dist/taskQueue.js",
+      "require": "./dist/taskQueue.js",
+      "types": "./dist/taskQueue.d.ts"
+    },
+    "./functions": {
+      "import": "./dist/functions/index.js",
+      "require": "./dist/functions/index.js",
+      "types": "./dist/functions/index.ts"
+    },
+    "./workflows": {
+      "import": "./dist/workflows/index.js",
+      "require": "./dist/workflows/index.js",
+      "types": "./dist/workflows/index.ts"
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^22.7.5"
+  }
+}

github/service.ts

@@ -0,0 +1,28 @@
+import Restack, { ServiceInput } from "@restackio/ai";
+
+import { githubTaskQueue } from "./taskQueue.js";
+import {
+  createRelease,
+  getReleases,
+  publishRelease,
+} from "./functions/index.js";
+
+export async function githubService({
+  client,
+  options = {
+    rateLimit: 100,
+  },
+}: {
+  client: Restack.default;
+  options?: ServiceInput["options"];
+}) {
+  await client.startService({
+    taskQueue: githubTaskQueue,
+    functions: { createRelease, getReleases, publishRelease },
+    options,
+  });
+}
+
+githubService({ client: new Restack.default() }).catch((err) => {
+  console.error("Error service:", err);
+});

github/taskQueue.ts

@@ -0,0 +1 @@
+export const githubTaskQueue = "github";

github/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./"
+  },
+  "include": ["**/*"]
+}

github/utils/client.ts

@@ -0,0 +1,17 @@
+import { Octokit } from "octokit";
+import { createTokenAuth } from "@octokit/auth-token";
+
+import "dotenv/config";
+
+export async function githubClient(
+  accessToken?: string
+): Promise<{ octokit: Octokit }> {
+  const auth = createTokenAuth(accessToken ?? process.env.GITHUB_AUTH_TOKEN!);
+  const { token } = await auth();
+
+  const octokit = new Octokit({
+    auth: token,
+  });
+
+  return { octokit };
+}