Issues Translate Action 使用教程

1. 项目目录结构及介绍

开源项目 Issues Translate Action 的目录结构如下所示：

issues-translate-action/
├── .github/
│   ├── workflows/
│   │   └── issue-translator.yml
├── __tests__/
├── dist/
├── src/
│   ├── all-contributorsrc/
│   ├── .eslintrc.json
│   ├── .gitattributes
│   ├── .gitignore
│   ├── .prettierrc.json
│   ├── jest.config.js
│   ├── package-lock.json
│   ├── package.json
│   ├── tsconfig.json
├── LICENSE
├── README.md
├── README_CN.md
└── action.yml

• .github/workflows/: 存放 GitHub Actions 工作流的配置文件。
• __tests__: 存放项目的测试代码。
• dist: 存放编译后的代码文件。
• src: 存放项目的源代码。
  • all-contributorsrc: 用于管理项目贡献者信息的文件。
  • .eslintrc.json: ESLint 的配置文件。
  • .gitattributes: 用于定义 Git 的一些行为，例如文件的换行符。
  • .gitignore: 用于定义 Git 忽略的文件和目录。
  • .prettierrc.json: Prettier 的配置文件。
  • jest.config.js: Jest 测试框架的配置文件。
  • package-lock.json: npm 包的锁定文件。
  • package.json: npm 包的配置文件。
  • tsconfig.json: TypeScript 的配置文件。
• LICENSE: 项目的 MIT 许可证。
• README.md: 项目的英文说明文档。
• README_CN.md: 项目的中文说明文档。
• action.yml: GitHub Action 的配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 GitHub Actions 的配置文件 issue-translator.yml，该文件定义了工作流的触发条件和执行步骤。以下是文件的内容示例：

name: 'issue-translator'
on:
  issue_comment:
    types: [created]
  issues:
    types: [opened]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: usthe/issues-translate-action@v2.7
      with:
        IS_MODIFY_TITLE: false
        # 其他配置项...

此配置文件定义了当有新的 Issue 打开或者 Comment 创建时，触发工作流。工作流在最新的 Ubuntu 环境中执行，并使用 usthe/issues-translate-action@v2.7 Action 来自动翻译非英文的内容。

3. 项目的配置文件介绍

项目的配置文件主要包括 .github/workflows/issue-translator.yml 和 action.yml。

• .github/workflows/issue-translator.yml: 如上所述，此文件用于配置 GitHub Actions 工作流。以下是配置文件的一些关键配置项：

  • IS_MODIFY_TITLE: 是否修改 Issue 的标题。
  • CUSTOM_BOT_NOTE: 自定义翻译机器人的前缀消息。

• action.yml: 此文件用于定义 GitHub Action 的具体行为和输入参数。以下是文件内容的示例：

name: 'Issues Translate Bot'
description: 'The action for translating Non-English issues content to English.'
inputs:
  IS_MODIFY_TITLE:
    description: 'Decide whether to modify the issue title'
    required: false
    default: false
  # 其他输入参数...

在编写教程时，请确保使用中文，并按照 markdown 格式输出。输出的第一行应为文章标题。避免在文章中包含无关字符和链接。