bluenotiondb
BluenotionDB Sync any service to Notion using Cron services like GitHub Actions.
Purpose
Notion does not support custom sync DB. I want to create sync DB for Bluesky or Twitter etc...
bluenotiondb
is customizable sync DB for Notion.
Supported Services
- Bluesky
- Pull Posts from Bluesky and push to Notion
- GitHub Activity
- Pull events of GitHub user and push to Notion
- Open/Close/Comment of Issues/PRs etc...
- GitHub Search
- Pull Issues/PRs or Repositories from GitHub Search and push to Notion
- iCal calendar like Google Calendar
- Pull events from iCal and push to Notion
- Required: need to setup
actions/cache
action to prevent duplicated items
- RSS Feeds
- Pull posts from RSS Feeds and push to Notion
- Required: need to setup
actions/cache
action to prevent duplicated items
Usage
Setup Notion
- Duplicate This Notion Template
- Create Notion Integration
- https://www.notion.so/my-integrations
- Copy the API key
- Also, You need to install the integration to your Notion Database
- Create
BLUENOTION_ENVS
env var using bluenotiondb env generator
via CLI
$ BLUENOTION_ENVS='[...]' ./bluenotiondb
via GitHub Actions
- Create GitHub repository
- Put
.github/workflows/update.yml
to the repository - Copy from https://github.com/azu/bluenotiondb/releases/latest and Paste to
.github/workflows/update.yml
- Set
BLUENOTION_ENVS
to GitHub repository secret
name: Update
on:
push:
branches:
- main
schedule:
# every 30 minutes
- cron: "*/30 * * * *"
workflow_dispatch:
env:
BLUENOTION_VERSION: v1.0.1
permissions:
contents: none
jobs:
update:
runs-on: ubuntu-latest
steps:
- name: Download
run: |
curl -L https://github.com/azu/bluenotiondb/releases/download/${{env.BLUENOTION_VERSION}}/bluenotiondb -o bluenotiondb
chmod +x bluenotiondb
- name: Update
run: ./bluenotiondb > /dev/null 2>&1
env:
BLUENOTION_ENVS: ${{ secrets.BLUENOTION_ENVS }}
Advanced Usage
Add custom field
notion_property_names
option is used for custom property name
You can change the property name by notion_property_names
option.
Title
: title columnURL
: URL type columnType
: Select type columnDate
: Date type columnParent
: Parent type column- Enable "Sub Item" in Notion
- It will be used for reply representation
For example, if you want to change Title
to Tasks
and URL
to url
, you can use notion_property_names
option.
[..., "notion_property_names":{ "Title": "Tasks", "URL": "url" }]
notion_extra
field is an object like{ propertyNames: propertyValue }
propertyNames
is property namepropertyValue
is notion payload
For example, if you want to add Tags
column to Notion, you can use notion_extra
option.
[..., "notion_extra":{ "Tags": { "multi_select": [{ "name": "TEST" }] }}]
Limitation: Currently does not put non-Ascii characters to .env
.
You can use unicode escape sequence like \u30bf\u30b9\u30af\u540d
instead of non-Ascii characters.
Recipe
Sync Google Calendar to Notion
- Copy your iCal URL from Google Calendar
- Create
BLUENOTION_ENVS
env var using bluenotiondb env generator - Create Update Calendar workflow
name: Update Calendar
on:
schedule:
# every 12 hours
- cron: "0 */12 * * *"
workflow_dispatch:
env:
BLUENOTION_VERSION: v1.0.1
permissions:
contents: read
actions: write # require to delete cache
jobs:
calendar:
runs-on: ubuntu-latest
env:
cache-name: cache-bluenotion-home
steps:
# actions/cache does not support overwrite cache
# https://github.com/actions/cache/issues/342
# This job implement overwrite cache using restore + delete + save
- name: Checkout
uses: actions/checkout@v3 # gh command require repository
- name: Restore Cache
id: cache-restore
uses: actions/cache/restore@v3
with:
path: ./cache
key: ${{ env.cache-name }}
- name: Download
run: |
curl -L https://github.com/azu/bluenotiondb/releases/download/${{env.BLUE_NOTION_VERSION}}/bluenotiondb -o bluenotiondb
chmod +x bluenotiondb
- name: Update
run: ./bluenotiondb > /dev/null 2>&1
env:
CACHE_DIR: ./cache
BLUE_NOTION_ENVS: ${{ secrets.BLUE_NOTION_ENVS }}
# overwrite cache key
- name: Delete Previous Cache
if: ${{ steps.cache-restore.outputs.cache-hit }}
continue-on-error: true
run: |
gh extension install actions/gh-actions-cache
gh actions-cache delete "${{ env.cache-name }}" --confirm
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Save Cache
uses: actions/cache/save@v3
with:
path: ./cache
key: ${{ env.cache-name }}
type
column
Overwrite If you want to overwrite built-in type
column, you can use notion_extra
option.
BLUENOTION_ENVS='[{"notion_database_id":"xxx","notion_api_key":"xxx","rss_url":"https://rsshub.app/github/repos/azu","notion_extra":{"Type":{"select":{"name":"My GitHub Repository"}}}}]'
Related
Architecture
- Fetch posts from Service
- Convert post to ServiceItem
- Push ServiceItem to Notion
graph LR
A[Fetch Service] --> B[Convert to ServiceItem]
B --> C[Push ServiceItem to Notion]
If you want to support a new service, you need to implement the following:
- Add
services/<service-name>.ts
- Implement
fetch~
function - Add Env type to
notion/envs.ts
- Add
fetch~
toindex.ts
Cache
If future date will be added, this service should be cached. Otherwise, dedupe events by using last updated date.
Development
To install dependencies:
bun install
To use local env:
- Create
BLUENOTION_ENVS
env var using bluenotiondb env generator - Crate
.env
file and pasteBLUENOTION_ENVS
to.env
BLUENOTION_ENVS='[...]'
To run:
bun run main
This project was created using bun init
in bun v0.6.0. Bun is a fast all-in-one JavaScript runtime.
Debug
You can use DEBUG
env to debug.
DEBUG=1 ./bluenotiondb
Release Flow
npm version {patch,minor,major}
npm run sync-version
git push --follow-tags
License
MIT