Update dependency @notionhq/client to v2 (#40)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Dotan Simha <[email protected]>

Author: renovate[bot]

.github/workflows/deploy.yaml

@@ -13,7 +13,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
       - run: npm install
       - name: Publish
         uses: cloudflare/[email protected]

README.md

@@ -47,18 +47,32 @@ To remove a public discussion:
 ## Getting started (development)
 
 1. Clone this repo
-2. Make sure to install Wrangler CLI: https://developers.cloudflare.com/workers/wrangler/get-started/
+2. Make sure to install Wrangler CLI: https://developers.cloudflare.com/workers/wrangler/get-started/ and use `pnpm`
 3. Create a Notion integration and get your Notion token (see https://www.notion.so/my-integrations). Use the token as `NOTION_TOKEN` env var.
 4. Create a GitHub Personal Access token for the relevant user (to create/update/delete the GH Discussions). Use the token as `GH_BOT_TOKEN` env var.
-5. Run `npm install`
-6. Run `npm start` for development.
+5. Create `.dev.vars` file and add `NOTION_TOKEN` and `GH_BOT_TOKEN` to it (and other env vars if needed, see below)
+6. Run `pnpm generate` to generate TypeScript types for the GraphQL queries.
+7. Run `pnpm install`
+8. Run `pnpm start` for development.
 
 > We use Wrangler for the Worker development.
 
+## Config
+
+The following configurations can be set in the env of your project, in order to customize how the bot will run:
+
+- `NOTION_TOKEN` - required, a Notion intergraion API key
+- `GH_BOT_TOKEN` - requried (also during development)
+- `DRY_RUN` - set to `1` if you wish to just test the create/update/delete plan of this bot, without affecting any data on GitHub.
+- `ENABLE_FETCH` - Set to `1` to enable. This will enable the `fetch` event for the worker, this is helpful for development if you want to trigger the bot manually, or if you wish your bot to have a manual trigger.
+- `CUSTOM_HEADER_LINK` - customize the link added to the header of every GitHub issue/discussion. To use an external like, you can add markdown, for example: `[The Guild's](https://the-guild.dev)`.
+
+For local development, please add your config to a file called `.dev.vars`
+
 ## Deployment (as CloudFlare Worker)
 
 - Every change to `main` branch will run CI and deploy to prod.
 - Make sure to configure your `NOTION_TOKEN` and `GH_BOT_TOKEN` (PAT) as part of the env vars.
-- You can also deploy from local env by running: `npm run deploy`
+- You can also deploy from local env by running: `pnpm run deploy`
 
 > If you wish to have a clone of your own, make sure to rename worker name in the `wrangler.toml` file

codegen.ts

@@ -0,0 +1,31 @@
+import { CodegenConfig } from "@graphql-codegen/cli";
+import { config as loadDotenv } from "dotenv";
+
+loadDotenv({
+  path: ".dev.vars",
+});
+
+const config: CodegenConfig = {
+  schema: [
+    {
+      "https://api.github.com/graphql": {
+        headers: {
+          Authorization: `Bearer ${process.env.GH_BOT_TOKEN}`,
+        },
+      },
+    },
+  ],
+  documents: "src/**/*.ts",
+  generates: {
+    "src/types.ts": {
+      config: {
+        scalars: {
+          URI: "string",
+        },
+      },
+      plugins: ["typescript", "typescript-operations"],
+    },
+  },
+};
+
+export default config;