Crowdin GitHub Action 使用指南

Crowdin GitHub Action 使用指南

github-actionA GitHub action to manage and synchronize localization resources with your Crowdin project项目地址:https://gitcode.com/gh_mirrors/github/github-action

一、项目目录结构及介绍

Crowdin GitHub Action 是一个用于自动化翻译和本地化管理的GitHub Action。它使得开发者能够轻松地将GitHub仓库中的字符串同步到Crowdin项目中进行翻译，然后将翻译结果自动拉回到仓库。此Action的目录结构简洁，通常包括以下核心部分：

• action.yml：这是GitHub Action的核心定义文件，描述了Action的工作流程、输入参数和执行逻辑。
• src：如果存在，可能包含实现Action功能的JavaScript源代码。
• .gitignore：指示Git在版本控制中忽略哪些文件或目录。
• README.md（示例性）：解释如何使用该Action的文档。

二、项目的启动文件介绍

Crowdin GitHub Action本身不直接有一个“启动文件”如传统应用般运行，但其触发和“启动”依赖于GitHub上的事件，比如push, pull_request, 或是Workflow文件中的定时任务等。关键在于.github/workflows目录下的YAML配置文件，这些配置文件定义了何时以及如何执行Crowdin Action。例如，一个典型的使用场景会有一个名为crowdin-sync.yml的文件，它会在每次向特定分支推送代码时触发Crowdin同步过程。

一个简单的例子配置片段可能如下所示：

name: Crowdin Sync

on:
  push:
    branches:
      - main

jobs:
  crowdin-sync:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout repository
      uses: actions/checkout@v2
    - name: Upload sources to Crowdin
      uses: crowdin/github-action@v2
      with:
        crowdin-token: ${{ secrets.CROWDIN_TOKEN }}
        upload-sources: true

这段配置说明当main分支接收到推送时，GitHub将会执行Crowdin的同步步骤，上传源文件到Crowdin平台。

三、项目的配置文件介绍

对于Crowdin GitHub Action来说，主要的配置并不直接存在于项目的主要目录结构中，而是通过GitHub Workflow YAML文件以及Crowdin本身的项目设置来完成。然而，为了更细粒度的控制，开发者可能需要编辑.crowdin.yaml文件（如果项目中有提供），这个文件位于项目根目录下，用来定义Crowdin的行为，比如指定需要翻译的文件类型、排除某些文件夹或文件、语言设置、以及翻译规则等。

例如，.crowdin.yaml的一个简化版可能包含以下内容：

files:
  - exclude: '.github/**'
  - extension: po
    file: 'locale/*.po'
    translation: 'locale/%two_letters_code%/%original_file_name%'

该配置告诉Crowdin要排除.github目录下的所有文件，并指定所有的.po文件作为源文件，它们的翻译文件应存储在对应的语言子目录下，保持相同的文件名结构。

以上就是关于Crowdin GitHub Action的基本使用和配置介绍。实际应用中，请参考最新版的官方文档来获取最准确的信息和最佳实践。

github-actionA GitHub action to manage and synchronize localization resources with your Crowdin project项目地址:https://gitcode.com/gh_mirrors/github/github-action