Skip to content

docs(deploy): replace the Pull app with the Sync fork workflow - #291

Merged
pseudoyu merged 2 commits into
mainfrom
docs/replace-pull-app
Oct 31, 2026
Merged

pseudoyu merged 2 commits into
mainfrom
docs/replace-pull-app

Conversation

@pseudoyu

Copy link
Copy Markdown
Member

Description

In short: The deployment guide tells people to install the Pull app to keep their RSSHub fork up to date, but GitHub turned that app off on October 1 (wei/pull#674, DIYgod/RSSHub#23673). This PR replaces those steps with a new section on keeping a fork updated, in English and Chinese.

What this PR changes

  1. One place for fork updates. A new "Keep Your Fork Updated" section (保持分叉更新) explains the manual "Sync fork" button and the daily "Sync fork" workflow added in feat(ci): sync forks with DIYgod/RSSHub once a day DIYgod/RSSHub#23734: turn on Actions in the fork, add a SYNC_TOKEN secret so updates also work on days RSSHub changes a workflow, and run it by hand to sync right away.
  2. Point the deploy steps at it. The Vercel, Heroku and Fly.io steps that said "install Pull" now link to that section. That is three places in each language.
  3. Say what turning on Actions costs. The section notes that turning on Actions also turns on RSSHub's other workflows in the fork, and that unneeded ones can be disabled.

Additional Information

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
@pseudoyu pseudoyu self-assigned this Oct 31, 2026
@pseudoyu
pseudoyu requested a review from TonyRL October 31, 2026 00:08
@netlify

netlify Bot commented Oct 31, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for rsshub-docs-next ready!

Name Link
🔨 Latest commit e6e049f
🔍 Latest deploy log https://app.netlify.com/projects/rsshub-docs-next/deploys/6ae5421beb0a2fef46028ead
😎 Deploy Preview https://deploy-preview-291--rsshub-docs-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Comment thread src/deploy/index.md Outdated

- 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Enable only the "Sync fork" workflow and disable other workflows.

Comment thread src/deploy/index.md
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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
::: 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.
:::

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.
@TonyRL
TonyRL self-requested a review October 31, 2026 01:27
@pseudoyu
pseudoyu merged commit c4d5575 into main Oct 31, 2026
7 checks passed
@pseudoyu
pseudoyu deleted the docs/replace-pull-app branch October 31, 2026 02:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants