GitHub动作：自动同步上游分支指南

GitHub动作：自动同步上游分支指南

Fork-Sync-With-Upstream-action An action to automatically update your fork with new commits from the upstream repo 项目地址: https://gitcode.com/gh_mirrors/fo/Fork-Sync-With-Upstream-action

一、项目目录结构及介绍

Fork-Sync-With-Upstream-action 是一款用于自动化更新你的代码库分叉中的分支，使其与原仓库的最新提交保持同步的GitHub Action。以下是其基本的目录结构概览：

• .gitignore: 指定了不应被Git版本控制的文件类型或文件名。
• LICENSE: 包含了MIT许可证的文本，说明了该项目的使用权限和限制。
• README.md: 项目的主要读我文件，提供了快速入门和关键信息。
• ACTION.yml: 这是GitHub Action的核心配置文件，定义了该Action的工作流程参数。
• src: 可能包含有实现自动同步逻辑的源代码文件，尽管没有直接展示出详细目录，通常这是一个存放主要功能实现的地方。
• USERS.md: 记录使用此工具的项目，鼓励用户贡献自己的使用实例。
• 其他必要文件（如工作流示例、配置文件等）：帮助用户设置和自定义Action。

二、项目的启动文件介绍

此项目主要通过GitHub Workflows进行“启动”，并非传统意义上的有一个单独的“启动文件”。关键在于配置文件（通常是.github/workflows/*.yml），这些YAML文件定义了行动的触发条件、步骤和其他细节。例如，你可能会在一个名为sync.yml的文件中配置以下内容来启动同步过程：

name: 'Upstream Sync'
on:
  schedule:
    - cron: '0 7 * * 1,4' # 每周一和周四的7点自动运行
  workflow_dispatch: # 允许手动触发
jobs:
  sync_latest_from_upstream:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        # ... 省略其他同步步骤配置

在这个上下文中，“启动”指的是触发GitHub Action的自动化流程，而非执行单个可执行文件。

三、项目的配置文件介绍

ACTION.yml

虽然实际的“配置文件”概念在这里更多地关联于GitHub Action使用的YAML文件（比如上面提到的工作流文件）。但就项目本身而言，重点配置主要包含在ACTION.yml（或在现代实践中可能是.github/workflows内的相关YAML文件）和在使用该Action时作为输入指定的变量。这些配置项包括：

• target_sync_branch: 目标分叉中要同步的分支，默认可以是'master', 'main', 或其他自定义分支。
• target_repo_token: 必需，目标仓库的访问令牌，通常通过GitHub Secrets管理。
• upstream_repo_access_token: 上游仓库的访问令牌（如果上游仓库为私有）。
• upstream_sync_repo: 上游仓库的地址，如'aormsby/Fork-Sync-With-Upstream-action'。
• upstream_sync_branch: 上游仓库中要拉取更新的分支，默认也是'master'或'main'等。
• test_mode: 用于测试而不会真正推送更改的选项。

在实际应用中，你需要在GitHub仓库的工作流配置文件中设置这些参数，以实现特定的同步需求。例如：

with:
  target_sync_branch: 'main'
  target_repo_token: ${{ secrets.GITHUB_TOKEN }}
  upstream_sync_repo: 'original-owner/original-repo'
  upstream_sync_branch: 'main'

这样，通过在GitHub Workflows中的适当配置，你就可以实现仓库分叉的自动同步了。

Fork-Sync-With-Upstream-action An action to automatically update your fork with new commits from the upstream repo 项目地址: https://gitcode.com/gh_mirrors/fo/Fork-Sync-With-Upstream-action