From a2d7fb9acf00218113240854fbb119418640d1db Mon Sep 17 00:00:00 2001 From: pseudoyu Date: Sat, 31 Oct 2026 09:07:41 +0900 Subject: [PATCH 1/2] docs(deploy): replace the Pull app with the Sync fork workflow GitHub suspended the Pull app on 2026-10-01 (wei/pull#674). Add a "Keep Your Fork Updated" section that covers the manual Sync fork button and the Sync fork workflow with a SYNC_TOKEN secret, and point the Vercel, Heroku and Fly.io steps at it in both languages. Refs DIYgod/RSSHub#23673 --- src/deploy/index.md | 20 +++++++++++++++++--- src/zh/deploy/index.md | 20 +++++++++++++++++--- 2 files changed, 34 insertions(+), 6 deletions(-) diff --git a/src/deploy/index.md b/src/deploy/index.md index 28eb28561..3addf7a82 100644 --- a/src/deploy/index.md +++ b/src/deploy/index.md @@ -477,6 +477,20 @@ sudo ansible-playbook rsshub.yaml # For example, if your users use https://rsshub.example.com to access your RSSHub instance, enter rsshub.example.com (remove the https://) ``` +## Keep Your Fork Updated + +Deployments that build from your fork (Vercel, Heroku, Fly.io and others) only pick up RSSHub changes after the fork is updated. + +- Manually: on your fork's GitHub page, click "Sync fork", then "Update branch". +- Automatically: RSSHub includes a "Sync fork" workflow that updates your fork from RSSHub once a day. + 1. Open the Actions tab of your fork and enable workflows. + 2. Create a [personal access token](https://github.com/settings/tokens) with the `workflow` scope, or a fine-grained token with read and write access to Contents and Workflows on your fork, and save it as a repository secret named `SYNC_TOKEN`. Without it the workflow uses the default token, which cannot update files under `.github/workflows/`, so the sync fails whenever RSSHub changes a workflow. + 3. To sync right away, run the "Sync fork" workflow from the Actions tab. + +Enabling workflows in a fork also enables RSSHub's other workflows there, such as the weekly full route test. You can disable the ones you don't need in the Actions tab. + +If your fork has changes that conflict with RSSHub, the sync fails and you need to resolve the conflict yourself. + ## Deploy to Vercel ### Instant deploy (without automatic update) @@ -487,7 +501,7 @@ sudo ansible-playbook rsshub.yaml 1. [Fork RSSHub](https://github.com/DIYgod/RSSHub/fork) to your GitHub account. 2. Deploy your fork to Vercel: Login Vercel with your GitHub account, create and deploy [new Vercel project](https://vercel.com/new/) with your RSSHub repository. -3. Install [Pull](https://github.com/apps/pull) app to keep your fork synchronized with RSSHub. +3. [Keep your fork updated](#deployment-keep-your-fork-updated) so new RSSHub changes get deployed. ::: tip If you encounter an `ERR_REQUIRE_ESM` error during deployment, you need to enable experimental Node.js require() of ES Module support. Add the environment variable `NODE_OPTIONS=--experimental-require-module` in your Vercel project settings. See [Vercel's documentation](https://vercel.com/docs/functions/runtimes/node-js/advanced-node-configuration#experimental-node.js-require-of-es-module) for more details. @@ -553,7 +567,7 @@ Without `BROWSER_SESSIONS`, each browser request using the `BROWSER` binding lau 1. [Fork RSSHub](https://github.com/DIYgod/RSSHub/fork) to your GitHub account. 2. Deploy your fork to Heroku: `https://heroku.com/deploy?template=URL`, where `URL` is your fork address (_e.g._ `https://github.com/USERNAME/RSSHub`). 3. Configure `automatic deploy` in Heroku app to follow the changes to your fork. -4. Install [Pull](https://github.com/apps/pull) app to keep your fork synchronized with RSSHub. +4. [Keep your fork updated](#deployment-keep-your-fork-updated) so new RSSHub changes get deployed. ## Deploy to Fly.io @@ -573,7 +587,7 @@ Without `BROWSER_SESSIONS`, each browser request using the `BROWSER` binding lau 6. [Set up automatic deployment via GitHub Actions](https://fly.io/docs/app-guides/continuous-deployment-with-github-actions/); 7. (Optional) Use `fly certs add your domain` to configure a custom domain, and follow the instructions to configure the related domain resolution at your DNS service provider (you can check the domain configuration status on the Dashboard Certificate page). -Upgrade: On the homepage of your Forked repository, click "Sync fork - Update Branch" to manually update to the latest official master branch, or install the [Pull](https://github.com/apps/pull) GitHub app to keep your fork synchronized with upstream. +Upgrade: On the homepage of your Forked repository, click "Sync fork - Update Branch" to manually update to the latest official master branch, or [sync it automatically](#deployment-keep-your-fork-updated). ### Method 2: Maintain fly.toml by yourself diff --git a/src/zh/deploy/index.md b/src/zh/deploy/index.md index ae228ee06..167cd8bb8 100644 --- a/src/zh/deploy/index.md +++ b/src/zh/deploy/index.md @@ -468,6 +468,20 @@ sudo ansible-playbook rsshub.yaml # 举例：如果您的 RSSHub 用户使用 https://rsshub.example.com 访问您的 RSSHub 实例，输入 rsshub.example.com（去掉 https://） ``` +## 保持分叉更新 + +从分叉部署的方式（Vercel、Heroku、Fly.io 等）只有在分叉更新后才会用上 RSSHub 的新改动。 + +- 手动更新：在分叉的 GitHub 页面点击「Sync fork」，再点「Update branch」。 +- 自动更新：RSSHub 自带一个「Sync fork」工作流，每天从 RSSHub 同步一次你的分叉。 + 1. 打开分叉的 Actions 页面，启用工作流。 + 2. 创建一个带 `workflow` 权限的 [个人访问令牌](https://github.com/settings/tokens)，或者对分叉的 Contents 和 Workflows 有读写权限的细粒度令牌，保存为名为 `SYNC_TOKEN` 的仓库 secret。不配置的话，工作流会使用默认令牌，它无法更新 `.github/workflows/` 下的文件，RSSHub 改动工作流时同步就会失败。 + 3. 想立即同步，可以在 Actions 页面手动运行「Sync fork」工作流。 + +在分叉里启用工作流后，RSSHub 的其他工作流（例如每周的全量路由测试）也会一起启用，用不到的可以在 Actions 页面单独停用。 + +如果你的分叉里有和 RSSHub 冲突的改动，同步会失败，需要你自己解决冲突。 + ## 部署到 Vercel ### 一键部署（无自动更新） @@ -478,7 +492,7 @@ sudo ansible-playbook rsshub.yaml 1. 将 RSSHub [分叉（fork）](https://github.com/DIYgod/RSSHub/fork) 到自己的账户下 2. 去 Vercel 部署一个新项目：使用 GitHub 账户登录 Vercel，进入 [项目创建页面](https://vercel.com/new/) 选择导入 RSSHub 仓库进行部署 -3. 安装 [Pull](https://github.com/apps/pull) 应用，定期将 RSSHub 改动自动同步至你的仓库 +3. 按 [保持分叉更新](#bu-shu-bao-chi-fen-cha-geng-xin) 设置自动同步，定期将 RSSHub 改动同步至你的仓库 ::: tip 如果在部署过程中遇到 `ERR_REQUIRE_ESM` 错误，需要启用 Node.js 实验性的 require() ES Module 支持。在 Vercel 项目设置中添加环境变量 `NODE_OPTIONS=--experimental-require-module`。详见 [Vercel 文档](https://vercel.com/docs/functions/runtimes/node-js/advanced-node-configuration#experimental-node.js-require-of-es-module)。 @@ -544,7 +558,7 @@ export { BrowserSession } from './utils/browser-session.worker'; 1. 将 RSSHub [分叉（fork）](https://github.com/DIYgod/RSSHub/fork) 到自己的账户下。 2. 把自己的分叉部署到 Heroku：`https://heroku.com/deploy?template=URL`，其中 `URL` 改为分叉地址 （例如 `https://github.com/USERNAME/RSSHub`）。 3. 检查 Heroku 设置，随代码库更新自动部署。 -4. 安装 [Pull](https://github.com/apps/pull) 应用，定期将 RSSHub 改动自动同步至你的分叉。 +4. 按 [保持分叉更新](#bu-shu-bao-chi-fen-cha-geng-xin) 设置自动同步，定期将 RSSHub 改动同步至你的分叉。 ## 部署到 Fly.io @@ -569,7 +583,7 @@ export { BrowserSession } from './utils/browser-session.worker'; 7. （可选）利用 `fly certs add 你的域名` 来配置自定义域名，并根据指引在你的 DNS 服务商配置相关域名解析（你可在 Dashboard Certificate 页面查看域名的配置状态）。 -更新：在你 Fork 出来的仓库首页点击「Sync fork - Update Branch」来手动更新至官方最新的 master 分支，或安装 [Pull](https://github.com/apps/pull) 应用来定期自动同步。 +更新：在你 Fork 出来的仓库首页点击「Sync fork - Update Branch」来手动更新至官方最新的 master 分支，或按 [保持分叉更新](#bu-shu-bao-chi-fen-cha-geng-xin) 设置定期自动同步。 ### 方案二：自行维护 fly.toml From e6e049f43c42cf938b59f8d6d7b776b489cbe026 Mon Sep 17 00:00:00 2001 From: pseudoyu Date: Sat, 31 Oct 2026 10:19:15 +0900 Subject: [PATCH 2/2] docs(deploy): keep only the Sync fork workflow enabled in forks Tell fork owners to disable every workflow except "Sync fork" after enabling Actions, and show the note about RSSHub's other workflows as a danger callout, as suggested in review. --- src/deploy/index.md | 4 +++- src/zh/deploy/index.md | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/src/deploy/index.md b/src/deploy/index.md index 3addf7a82..53d7b24ea 100644 --- a/src/deploy/index.md +++ b/src/deploy/index.md @@ -483,11 +483,13 @@ Deployments that build from your fork (Vercel, Heroku, Fly.io and others) only p - Manually: on your fork's GitHub page, click "Sync fork", then "Update branch". - Automatically: RSSHub includes a "Sync fork" workflow that updates your fork from RSSHub once a day. - 1. Open the Actions tab of your fork and enable workflows. + 1. Open the Actions tab of your fork and enable workflows, then keep only the "Sync fork" workflow enabled and disable the others. 2. Create a [personal access token](https://github.com/settings/tokens) with the `workflow` scope, or a fine-grained token with read and write access to Contents and Workflows on your fork, and save it as a repository secret named `SYNC_TOKEN`. Without it the workflow uses the default token, which cannot update files under `.github/workflows/`, so the sync fails whenever RSSHub changes a workflow. 3. To sync right away, run the "Sync fork" workflow from the Actions tab. +::: danger Enabling workflows in a fork also enables RSSHub's other workflows there, such as the weekly full route test. You can disable the ones you don't need in the Actions tab. +::: If your fork has changes that conflict with RSSHub, the sync fails and you need to resolve the conflict yourself. diff --git a/src/zh/deploy/index.md b/src/zh/deploy/index.md index 167cd8bb8..e19f15fa6 100644 --- a/src/zh/deploy/index.md +++ b/src/zh/deploy/index.md @@ -474,11 +474,13 @@ sudo ansible-playbook rsshub.yaml - 手动更新：在分叉的 GitHub 页面点击「Sync fork」，再点「Update branch」。 - 自动更新：RSSHub 自带一个「Sync fork」工作流，每天从 RSSHub 同步一次你的分叉。 - 1. 打开分叉的 Actions 页面，启用工作流。 + 1. 打开分叉的 Actions 页面启用工作流，然后只保留「Sync fork」工作流，停用其他工作流。 2. 创建一个带 `workflow` 权限的 [个人访问令牌](https://github.com/settings/tokens)，或者对分叉的 Contents 和 Workflows 有读写权限的细粒度令牌，保存为名为 `SYNC_TOKEN` 的仓库 secret。不配置的话，工作流会使用默认令牌，它无法更新 `.github/workflows/` 下的文件，RSSHub 改动工作流时同步就会失败。 3. 想立即同步，可以在 Actions 页面手动运行「Sync fork」工作流。 +::: danger 在分叉里启用工作流后，RSSHub 的其他工作流（例如每周的全量路由测试）也会一起启用，用不到的可以在 Actions 页面单独停用。 +::: 如果你的分叉里有和 RSSHub 冲突的改动，同步会失败，需要你自己解决冲突。