实现使用Github Action自动同步fork的上游仓库
把同学写的一个仓库fork到了github组织当中。但是同学每次更新，在组织中的仓库都需要手动同步一下，觉得很麻烦，于是开始在谷歌上搜索。
过程中有看到这篇帖子，但是最后没有采取最高赞的回答的方法。
最后找到了这个仓库/action应用
aormsby/Fork-Sync-With-Upstream-action: An action to automatically update your fork with new commits from the upstream repo
由于仓库 README.md 中，对于各个参数的说明没有太详细，而给出的使用示例中，又使用了较多的参数
使用示例
| name: 'Upstream Sync'
on:
schedule:
- cron: '0 7 * * 1,4'
# scheduled at 07:00 every Monday and Thursday
workflow_dispatch: # click the button on Github repo!
inputs:
sync_test_mode: # Adds a boolean option that appears during manual workflow run for easy test mode config
description: 'Fork Sync Test Mode'
type: boolean
default: false
jobs:
sync_latest_from_upstream:
runs-on: ubuntu-latest
name: Sync latest commits from upstream repo
steps:
# REQUIRED step
# Step 1: run a standard checkout action, provided by github
- name: Checkout target repo
uses: actions/checkout@v3
with:
# optional: set the branch to checkout,
# sync action checks out your 'target_sync_branch' anyway
ref: my-branch
# REQUIRED if your upstream repo is private (see wiki)
persist-credentials: false
# REQUIRED step
# Step 2: run the sync action
- name: Sync upstream changes
id: sync
uses: aormsby/Fork-Sync-With-Upstream-action@v3.4.1
with:
target_sync_branch: my-branch
# REQUIRED 'target_repo_token' exactly like this!
target_repo_token: ${{ secrets.GITHUB_TOKEN }}
upstream_sync_branch: main
upstream_sync_repo: aormsby/Fork-Sync-With-Upstream-action
upstream_repo_access_token: ${{ secrets.UPSTREAM_REPO_SECRET }}
# Set test_mode true during manual dispatch to run tests instead of the true action!!
test_mode: ${{ inputs.sync_test_mode }}
# Step 3: Display a sample message based on the sync output var 'has_new_commits'
- name: New commits found
if: steps.sync.outputs.has_new_commits == 'true'
run: echo "New commits were found to sync."
- name: No new commits
if: steps.sync.outputs.has_new_commits == 'false'
run: echo "There were no new commits."
- name: Show value of 'has_new_commits'
run: echo ${{ steps.sync.outputs.has_new_commits }}
|
尤其是看到还需要设置 upstream_repo_access_token
所以一开始没敢直接用，又去谷歌上搜索到了一个使用这个action的文章，
Sync Forks to Upstream Using GitHub Actions - DEV Community
查看了这篇文章中的使用方法，
| // https://github.com/open-sauced/goals-template/blob/main/.github/workflows/sync-2-upstream.yml
name: Sync to Upstream
on:
schedule:
- cron: '12 7 * * 1,4'
# scheduled at 07:12 every Monday and Thursday
workflow_dispatch:
jobs:
sync_with_upstream:
runs-on: ubuntu-latest
name: Sync HEAD with upstream latest
steps:
# Step 1: run a standard checkout action, provided by github
- name: Checkout HEAD
uses: actions/checkout@v2
with:
ref: main
# Step 2: run this sync action - specify the upstream repo, upstream branch to sync with, and target sync branch
- name: Pull upstream changes
id: sync
uses: bdougie/Fork-Sync-With-Upstream-action@fork
with:
upstream_repository: open-sauced/goals-template
upstream_branch: main
target_branch: main # optional
github_token: ${{ secrets.GITHUB_TOKEN }} # optional, for accessing repos that require authentication
|
发现竟然可以直接没有设置 upstream_repo_access_token，于是开始尝试编写使用这个action的workflow。
需要注意的是，这类自动同步上游仓库的workflow通常都是设置成定时触发的，设置触发时间的方法可以参考这两个部分
设置触发时间方法摘要
计划任务语法有五个字段，中间用空格分隔，每个字段代表一个时间单位。
┌───────────── minute (0 - 59)
│ ┌───────────── hour (0 - 23)
│ │ ┌───────────── day of the month (1 - 31)
│ │ │ ┌───────────── month (1 - 12 or JAN-DEC)
│ │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
│ │ │ │ │
│ │ │ │ │
│ │ │ │ │
* * * * *
你可在这五个字段中使用以下运算符：
| 运算符 |
说明 |
示例 |
| * |
任何值 |
15 * * * * 在每天每小时的每个第 15 分钟运行。 |
| , |
值列表分隔符 |
2,10 4,5 * * * 在每天第 4 和第 5 小时的第 2 和第 10 分钟运行。 |
| - |
值的范围 |
30 4-6 * * * 在第 4、5 和 6 小时的第 30 分钟运行。 |
| / |
步骤值 |
20/15 * * * * 在第 20 分钟到第 59 分钟每隔 15 分钟运行一次（第 20、35 和 50 分钟）。 |
于是我最后编写成了
| sync-fork.yml |
|---|
| name: 'Upstream Sync'
on:
schedule:
- cron: '*/21 * * * *'
# Runs every 21 minutes
workflow_dispatch: # click the button on Github repo!
inputs:
sync_test_mode: # Adds a boolean option that appears during manual workflow run for easy test mode config
description: 'Fork Sync Test Mode'
type: boolean
default: false
permissions:
contents: write
jobs:
sync_latest_from_upstream:
runs-on: ubuntu-latest
name: Sync latest commits from upstream repo
steps:
# REQUIRED step
# Step 1: run a standard checkout action, provided by github
- name: Checkout target repo
uses: actions/checkout@v3
with:
# optional: set the branch to checkout,
# sync action checks out your 'target_sync_branch' anyway
ref: main
# REQUIRED if your upstream repo is private (see wiki)
# persist-credentials: false
# REQUIRED step
# Step 2: run the sync action
- name: Sync upstream changes
id: sync
uses: aormsby/Fork-Sync-With-Upstream-action@v3.4.1
with:
target_sync_branch: main
# REQUIRED 'target_repo_token' exactly like this!
target_repo_token: ${{ secrets.GITHUB_TOKEN }}
upstream_sync_branch: main
upstream_sync_repo: GaoZQi/material-mkdocs-theme
# upstream_repo_access_token: ${{ secrets.UPSTREAM_REPO_SECRET }}
# Set test_mode true during manual dispatch to run tests instead of the true action!!
test_mode: ${{ inputs.sync_test_mode }}
# Step 3: Display a sample message based on the sync output var 'has_new_commits'
- name: New commits found
if: steps.sync.outputs.has_new_commits == 'true'
run: echo "New commits were found to sync."
- name: No new commits
if: steps.sync.outputs.has_new_commits == 'false'
run: echo "There were no new commits."
- name: Show value of 'has_new_commits'
run: echo ${{ steps.sync.outputs.has_new_commits }}
|
最后手动运行workflow进行测试，成功。
但是由于位于默认分支中的workflow才能在actions中看到，才能被手动触发。如果想要一个完全和上游仓库一致的分支，那么一个可行的解决办法是，创建一个单独的分支(可以叫做gh-actions)用于存放workflow，再把这个分支修改设置成默认分支，然后就可以在actions中看到这个workflow了。
如果要创建空白的分支可以使用
git checkout --orphan gh-actions
最后更新:
2025-04-01
创建日期:
2025-03-31