notion-github-sync
This bot syncs public Notion pages as GitHub Discussions/Issues. It's done periodically, based on the pages shared with the Notion Integration, and based on metadata specific on your Notion page.
Usage
To use this tool, please make sure to have the following:
- Deploy this tool or run it locally with the relevant env vars.
- Make sure to add the user your wish to use as collaborator in your repos (this is needed only in order to delete Discussions)
- To make a Notion page public and syncable, first make sure to share this page with the Notion Integration you created:
- If you wish to make the Notion page public (with the Notion url), also tick
Share to web:
- Annotate the top of your Notion page with the repo you wish to sync the page with the following text (NOT as code block, just as text - this should be the first block of your Notion page):
/github-public dotansimha/test-notion-sync discussion
You can also specify a custom GitHub Discussion category (the default is General):
/github-public dotansimha/test-notion-sync discussion General
Or, as an issue:
You can also specify a custom GitHub Discussion category (the default is General):
/github-public dotansimha/test-notion-sync issue
You can find a synced example page here: dotansimha/test-notion-sync#12
To remove a public discussion:
- Make sure to delete the annotation from your page.
- Wait for the next sync (or, manually run it)
- You can also remove now the integration access from the page.
Getting started (development)
- Clone this repo
- Make sure to install Wrangler CLI: https://developers.cloudflare.com/workers/wrangler/get-started/
- Create a Notion integration and get your Notion token (see https://www.notion.so/my-integrations). Use the token as
NOTION_TOKENenv var. - Create a GitHub Personal Access token for the relevant user (to create/update/delete the GH Discussions). Use the token as
GH_BOT_TOKENenv var. - Run
npm install - Run
npm startfor development.
We use Wrangler for the Worker development.
Deployment (as CloudFlare Worker)
- Every change to
mainbranch will run CI and deploy to prod. - Make sure to configure your
NOTION_TOKENandGH_BOT_TOKEN(PAT) as part of the env vars. - You can also deploy from local env by running:
npm run deploy
If you wish to have a clone of your own, make sure to rename worker name in the
wrangler.tomlfile
7 Dec 16, 2022
17 Dec 22, 2022
7 Jan 6, 2023
6 Jul 11, 2022
41 Jan 7, 2023
2 Feb 15, 2022
2 Jan 14, 2022
4 Jul 16, 2022
5 Oct 26, 2022
12 Oct 1, 2022
10 Oct 4, 2022
19 Nov 7, 2022
4 Jul 1, 2022
2.8k Dec 31, 2022
4 Feb 24, 2022
8 May 19, 2022
4 May 4, 2022
11 Dec 8, 2022
58 Nov 27, 2022