Repo File Sync Action 使用指南

一、项目目录结构及介绍

Repo File Sync Action 是一个专为GitHub设计的行动式同步工具，其核心功能在于自动同步不同仓库间的文件或整个目录。虽然具体的仓库目录结构可能会随着版本迭代和维护更新而有所变化，但一个典型的开源项目通常会有以下基本结构：

• .github: 此目录存放与GitHub相关的配置，包括Workflows文件。

  • workflows: 包含所有GitHub Actions的定义文件，其中应有一个名为sync.yml的文件用于配置同步作业。
  • sync.yml: 项目特有的配置文件，指定了哪些文件或目录需要同步以及同步的目标仓库。

• src: 若项目涉及代码，此目录通常存放源代码文件。

• dist: 编译后的产出物可能会存放于此，但在Repo File Sync Action项目中可能不适用。

• .gitignore: 定义了Git应该忽略的文件模式。

• LICENSE: 许可证文件，说明了项目使用的授权条款，本项目使用MIT许可证。

• README.md: 项目的主要文档，提供了快速入门和项目概述。

• package.json, package-lock.json: Node.js项目的基本配置和依赖锁文件。

• action.yml: GitHub Action的定义文件，描述了Action的行为和参数。

二、项目的启动文件介绍

主要运行文件：sync.yml

在.github/workflows目录下的sync.yml是触发Repo File Sync Action的关键文件。通过定义工作流，你能够设置在特定事件（如push到main或master分支）发生时自动执行文件同步任务。此文件的基本结构示例如下：

name: Sync Files
on:
  push:
    branches:
      - main
      - master
  workflow_dispatch:
jobs:
  sync:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repository
        uses: actions/checkout@main
      - name: Run GitHub File Sync
        uses: BetaHuhn/repo-file-sync-action@v1
        with:
          GH_PAT: ${{ secrets.GH_PAT }}

这段代码告诉GitHub，在指定分支收到推送时或者手动触发时，运行这个工作流来同步文件。它首先检出仓库，然后调用Repo File Sync Action，并传入个人访问令牌（PAT）作为参数。

三、项目的配置文件介绍

同步配置文件：github/sync.yml

为了指明同步的具体细节，你需要在项目根目录的.github同级创建或编辑一个sync.yml文件。这一步骤是关键，因为它定义了哪些文件或者目录需要同步到哪些目标仓库及其分支。示例配置如下：

user/repo-target:
  - github/workflows/workflow-to-sync.yml

这里，user/repo-target指定目标仓库的用户名和仓库名，接着列出需要同步的文件路径。若需指定到特定分支或有更复杂的配置，可以在目标仓库后面加上@branch。

---

综上所述，Repo File Sync Action通过精心设计的配置与工作流文件，实现了无缝的仓库间文件同步，大大简化了多仓库管理中的重复工作。正确配置上述文件后，你的项目就能享受到便捷的自动化同步服务。