把代码仓库当做数据库， github action 持久化存储新思路

背景

我想做一个 rss 订阅机器人，通过一个定时任务定期将我关注的内容推送到我的 Tailchat 群组。但是我又不想自己去单独搭建一个服务器来部署，因为功能很小、单独部署的成本会被放大，也不容易被其他人很简单的使用。而且长期维护的成本也是比较高的，希望能处于无人值守的运行模式

那么整理一下需求:

定时任务
简单部署
不需要运维

可以说是非常理想了，那么有这样成熟的解决方案么？答案是有的。那就是github action。

Github action 可以满足我的所有需求，只需要一个简单的定时任务即可实现我的三个需求。唯一的难点在于数据库，也就是持久化存储。

众所周知，rss 机器人的原理就是定时请求 rss 订阅地址，将返回的内容结构化以后与之前存储的数据进行比较，将更新的信息提取出来发送到外部服务。那么为了能够比较差异，一个持久化的数据库是必不可少的。那么github action可以实现数据库么？答案是可以的，我只需要将数据存储在代码仓库中，每次执行 action 之前将数据取出，然后在 action 执行完毕之后将数据存回仓库，那么一个用于低频读写的文件数据库就实现了。

理论存在，实践开始！

开始造轮子

在 github 上搜索了一圈没有发现有现成的轮子，因此就开始自己造一个。

核心流程如下：

准备数据流程

通过 git worktree 创建一个独立的工作区
指定工作区的分支为一个独立分支用于存储数据
如果该分支之前不存在，跳过准备过程
如果分支已存在，拉取分支代码，将存储分支的指定目录文件复制到主工作空间的指定目录文件

修改数据

在后续的 action 中执行脚本
脚本读取文件数据库，在这里使用的是lowdb，当然也可以使用 sqlite ，看个人喜好
更新数据库并写入

持久化存储数据

action 执行完毕进入 post 阶段
执行 post action 将主工作区的数据库文件覆盖到存储工作区中
存储工作区通过 github action 的 token 或者传入参数的 token 提交变更到 github 的存储分支中。
结束流程，等待后续的执行

成果

那么通过上面一系列步骤，我们就成功把 github 当做我们自己的 action 应用的数据库了。

一个简单的示例如下:

name: Tests

on:
  workflow_dispatch:

jobs:
  test:
    timeout-minutes: 60
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Checkout date
      uses: moonrailgun/branch-filestorage-action@v1.2.2
      with:
        path: date
    - name: Read and show
      run: cat date
    - name: update date
      run: echo $(date) > date

这个 action 表示，每执行一次，我们的actions/filedb中的 date 文件就会更新成最新的.当然也可以加上一些定时任务触发器让他自动执行。当然建议不要滥用哦，可以使用低频一些

在 Github Marketplace 查看: https://github.com/marketplace/actions/branch-filestorage-action

开源地址: moonrailgun/branch-filestorage-action

RSSBot 地址: msgbyte/tailchat-rss-bot

moonrailgun

2022-05-27 15:06:30 +08:00

@ihciah
感谢提醒与友善的回复。不过我仔细看了一下你指出的两条跟我造的 github action 轮子(branch-filestorage-action)好像没有任何关系。。。

对于我的使用实例(rssbot) 第二条，我不认为 rss 属于 `unauthorized` 的内容。rss 的内容本身就是网站允许的一种访问方式。如果网站不允许通过 rss 访问可以不添加 rss 协议。。。这个我认为其"允许访问"程度比搜索引擎还要高 —— 搜索引擎是你申明不允许那么就不抓取，rss 是你不主动创造 rss 的 xml 信息就无法使用。。。

第四条的话，在我的实例中，我创建了一个 rss 机器人的项目，然后使用 action 收集 rss 的数据，怎么都不能说这两者是无关的吧？
类似的项目有收集程序员编码时间，生成 gist 的 waka-box(1.1k star,1.5k fork)
定时抓取 ipaddress ，更新 hosts 的 github520(11.5k star, 1.3k fork)
以及更多程序员都会使用的更新到自己项目的 repo 然后动态变更个人首页展示内容(不好意思这种我没用过我没法举出例子)

虽然不是非常认可你的说法，但是还是非常感谢您的回复。 :)