Deploy Notion2Markdown-Action for Hexo Project Using GitHub Actions

2023-09-07 826 words 4 minutes

Contents

In this post, we’ll walk you through the process of deploying the Notion2Markdown-Action for your Hexo project using GitHub Actions. This workflow allows you to synchronize content from Notion to your Hexo blog automatically. We’ll provide a detailed explanation of how to set up the necessary configurations and secrets for this GitHub Actions workflow.

Prerequisites

Before you get started, make sure you have the following prerequisites in place:

Notion Database

For Notion side, you have a prepare a notion dataset and notion integration secret.

For the former, we provide a template here, feel free to duplicate it.

For the notion integration, here is a guide about how to get the integration secret and connect it to the dataset.

DO NOT FORGET TO CONNECT THE DATABASE TO YOUR NOTION INTEGRATION!!!

At this point, NOTION_SECRET and NOTION_DATABASE_ID should have been obtained.

A configured image hosting service

If you want to upload all the images hosted by notion, a configured image hosting service shoud be prepared for this action.

Our picture bed service is based on PicGo-Core, so smms/qiniu/upyun/tcyun/github/aliyun/imgur are supported to be the backend service.

And a JSON configure file should be prepared as PIC_BED_CONFIG, according to the docs. Here is an example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "uploader": "aliyun",
  "aliyun":
    {
      "accessKeyId": "",
      "accessKeySecret": "",
      "bucket": "",
      "area": "",
      "path": "",
      "customUrl": "",
      "options": "",
    },
}

GitHub Actions Workflow

Let’s break down the GitHub Actions workflow step by step.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
name: Notion2Hexo

on:
  workflow_dispatch:
  schedule:
    - cron: "*/30 * * * *"

permissions:
  contents: write

jobs:
  notionSyncTask:
    name: Notion2hexo on ubuntu-latest
    runs-on: ubuntu-latest

    steps:
      - name: Checkout blog and theme
        uses: actions/checkout@v3
        with:
          submodules: "recursive"
          fetch-depth: 0

      - name: Check the NOTION_SYNC_DATETIME
        id: GetNotionSyncDatetime
        run: |
          NOTION_SYNC_DATETIME=$(git log -n 1 --grep="NotionSync" --format="%aI")
          echo "NOTION_SYNC_DATETIME=$NOTION_SYNC_DATETIME" >> "$GITHUB_OUTPUT"
          echo -e "Latest notion sync datetime:\\\\n$NOTION_SYNC_DATETIME"          

      - name: Convert notion to markdown
        id: NotionSync
        uses: Doradx/notion2markdown-action@v1
        with:
          notion_secret: ${{ secrets.NOTION_SECRET }}
          database_id: ${{ secrets.NOTION_DATABASE_ID }}
          pic_migrate: true
          pic_bed_config: ${{ secrets.PICBED_CONFIG }}
          pic_compress: true
          output_page_dir: "source"
          output_post_dir: "source/_posts/notion"
          clean_unpublished_post: true
          metas_keeped: abbrlink
          metas_excluded: pstatus,ptype
          last_sync_datetime: ${{ steps.GetNotionSyncDatetime.outputs.NOTION_SYNC_DATETIME }}
      - name: Hexo deploy
        if: steps.NotionSync.outputs.updated_count != '0'
        run: |
          git pull
          npm install && npm run deploy          

      - name: Commit & Push
        if: steps.NotionSync.outputs.updated_count != '0'
        uses: stefanzweifel/git-auto-commit-action@v4
        with:
          file_pattern: "source/"
          commit_message: Automatic NotionSync.

Configuration Details

Now, let’s explain each part of the workflow in detail.

Schedule: The workflow can be triggered manually or on a schedule using the schedule option. In this example, it runs every 30 minutes between 7 AM and 10 PM.
Permissions: This workflow requires write permissions to the repository content to update your Hexo blog.
notionSyncTask: This is the main job of the workflow.
- Checkout blog and theme: It checks out your Hexo blog repository and its submodules.
- Check the NOTION_SYNC_DATETIME: This step retrieves the latest sync datetime from the Git history for tracking changes.
- Convert notion to markdown: This step uses the Notion2Markdown-Action to sync content from Notion to your Hexo blog. It requires several secrets and configurations:
  - notion_secret: Your Notion integration secret. HOW TO GET IT?
  - database_id: The ID of the Notion database you want to sync. HOW TO GET IT?
  - pic_migrate: Set to true to migrate images from Notion to your pic_bed_config.
  - pic_bed_config: Configuration for your image hosting service.
  - pic_compress: Set to true to compress images.
  - output_page_dir and output_post_dir: Directories where the converted content will be placed in your Hexo project.
  - clean_unpublished_post: Set to true to clean unpublished posts.
  - metas_keeped and metas_excluded: Metadata options.
  - last_sync_datetime: The datetime of the last sync, retrieved in the previous step.
- Hexo deploy: This step runs when content has been updated. It pulls changes, installs dependencies, and deploys your Hexo blog.
- Commit & Push: Also runs when content has been updated, it commits and pushes the changes to your repository with a specified commit message.

Setting Up Secrets

To use this workflow, you need to set up the following secrets in your GitHub repository, with the location Settings→Secrets and variables→Actions→Secrets→New repository secret.

NOTION_SECRET: Your Notion integration secret.
NOTION_DATABASE_ID: The ID of the Notion database you want to sync.
PICBED_CONFIG: Configuration for your image hosting service.

Enjoying!

The workflow is usually triggered according to the schedule, but you can also trigger it manually to see whether it works fine. Tap Actions→Notion2Hexo→Run workflow to run it.

Conclusion

With this GitHub Actions workflow, you can automate the process of syncing content from Notion to your Hexo blog. Ensure that you have all the prerequisites and secrets set up correctly to make this workflow work seamlessly. Once configured, your Hexo blog will stay up-to-date with your Notion content automatically.