Unity Actions 使用指南

Unity Actions 使用指南

unity-actionsGithub actions for testing and building Unity projects项目地址:https://gitcode.com/gh_mirrors/un/unity-actions

本文将指导您了解并使用 game-ci/unity-actions 开源项目，该项目旨在自动化Unity游戏开发中的CI（持续集成）流程。

1. 项目目录结构及介绍

game-ci/unity-actions 的目录结构如下：

.
├── README.md      # 项目说明文件
├── .github        # GitHub Actions 相关配置文件夹
│   └── workflows  # 包含具体的 CI 工作流定义
└── tools          # 辅助工具脚本
    ├── build       # 构建相关的脚本
    └── test        # 测试相关的脚本

• .github/workflows: 存放GitHub Actions的工作流程文件，这些YAML文件定义了自动化任务的执行步骤。
• tools/build: 提供构建Unity工程的脚本。
• tools/test: 包含用于测试Unity项目的脚本。

2. 项目的启动文件介绍

在 game-ci/unity-actions 中并没有传统的“启动文件”，因为它是GitHub Actions的配置集合。项目的核心在于.github/workflows目录下的YAML文件，例如build.yml或test.yml。这些文件定义了自动化操作的顺序和条件，当您在GitHub上触发相应的事件时（如代码推送），这些动作会被执行。

一个示例build.yml工作流文件可能如下所示：

name: Build & Test Unity Project

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  build_and_test:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout Repository
      uses: actions/checkout@v2
    - name: Setup Unity
      uses: game-ci/unity-setup@v1
      with:
        unityVersion: 2020.3
    - name: Build Unity Project
      uses: game-ci/unity-action@v1
      with:
        workingDirectory: path/to/your/project
        buildTarget: Android
    - name: Run Tests
      # 这里可以添加运行测试的脚本或者使用其他Unity动作

这个例子中，build_and_test job 在接收到main分支的push或pull request时运行，它首先检出仓库，然后设置Unity环境，接着构建Android平台的目标项目，并执行任何测试步骤。

3. 项目的配置文件介绍

项目的主要配置文件是.github/workflows目录下的YAML文件，例如build.yml。这些文件以YAML格式描述了GitHub Actions的工作流程，包括触发条件、运行环境、执行步骤等。

以下是一些常见的配置键值：

• on: 定义触发此工作流的事件，可以是push、pull_request或其他事件。
• jobs: 作业的集合，每个作业（job）代表一组独立的任务。
• steps: 作业内的步骤，每个步骤通常表示一个操作，例如安装依赖、执行脚本等。
• uses: 步骤使用的GitHub Action，这可以是项目内部提供的，也可以是外部公共Action。
• with: 提供给Action的参数，例如unityVersion来指定Unity的版本。

您可以根据项目需求修改或扩展这些配置文件，以便定制化的自动化您的Unity项目构建和测试流程。

要了解更多详细信息，请查阅项目README 和 官方文档。

unity-actionsGithub actions for testing and building Unity projects项目地址:https://gitcode.com/gh_mirrors/un/unity-actions