Build Godot Action 使用教程

Build Godot Action 使用教程

build-godot-actionGitHub action that builds a Godot project for multiple platforms项目地址:https://gitcode.com/gh_mirrors/bu/build-godot-action

1. 项目的目录结构及介绍

build-godot-action/
├── .github/
│   └── workflows/
│       └── build.yml
├── README.md
├── action.yml
└── src/
    └── main.js

• .github/workflows/build.yml: 定义了GitHub Actions的工作流程，用于自动化构建Godot项目。
• README.md: 项目说明文档，包含项目的基本信息和使用方法。
• action.yml: 定义了GitHub Action的元数据，包括输入、输出和运行环境。
• src/main.js: 项目的核心脚本，负责执行构建任务。

2. 项目的启动文件介绍

项目的启动文件是 src/main.js，它是一个JavaScript脚本，负责执行构建Godot项目的任务。该脚本会根据配置文件中的参数，自动化地构建Godot项目，并生成相应的输出文件。

3. 项目的配置文件介绍

主要的配置文件是 .github/workflows/build.yml，它定义了GitHub Actions的工作流程。以下是该文件的基本结构和内容：

name: Build Godot Project

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

jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        platform: [linux, windows, mac]

    steps:
    - uses: actions/checkout@v2
      with:
        lfs: true

    - name: Build Godot
      id: build
      uses: yeslayla/build-godot-action@v1.4.1
      with:
        preset: ${{ matrix.platform }}
        debugMode: "true"

    - name: Upload Artifact
      uses: actions/upload-artifact@v2
      with:
        name: Client-${{ matrix.platform }}
        path: ${{ github.workspace }}/${{ steps.build.outputs.build }}

• name: 工作流程的名称。
• on: 定义触发工作流程的事件，例如push和pull request。
• jobs: 定义工作流程中的任务。
  • build: 构建任务的名称。
    • runs-on: 指定运行任务的虚拟环境。
    • strategy: 定义任务的矩阵策略，支持多个平台。
    • steps: 定义任务的具体步骤。
      • actions/checkout@v2: 检出代码。
      • Build Godot: 使用 yeslayla/build-godot-action 进行构建。
      • Upload Artifact: 上传构建结果。

通过以上配置文件，可以自动化地构建Godot项目，并生成相应的输出文件。

build-godot-actionGitHub action that builds a Godot project for multiple platforms项目地址:https://gitcode.com/gh_mirrors/bu/build-godot-action