GGua 日本語リファレンス
英語版が正式な参照です。内容に差異がある場合は、英語版を優先してください。
DOCS / CI

GitHub Actions

gua-project/gua-testerは、Godot 4.7とUnity 6のGua UIテストを実行するバージョン付きCI workflowを提供します。

Godot 4.7

Godot composite Actionはrunnerに合うGodot公式版を取得し、配布済みGua addonを配置してGODOT_EXECUTABLEを設定します。project import後、外部Gua.Testing.Godotテストを実行します。

.github/workflows/godot.ymlyaml
jobs:
  godot:
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v4
      - uses: gua-project/gua-tester/godot@v3.2
        with:
          project-path: game
          test-project: tests/GuaTester.Tests.csproj
          godot-version: "4.7"
          godot-status: stable
          gua-plugin-tag: gua-v1.1.1
test-project(必須)

Gua.Testing.Godotを参照する.csprojです。

project-path

Godot projectのパス。既定値はgameです。

godot-version / godot-status

既定値は4.7とstableです。

test-logger

既定値はtrx;LogFileName=godot.trxです。

出力はgodot-executableとaddon-pathです。構成Actionのgua-project/gua-tester/setup-godot@v3.2とgua-project/gua-tester/link-gua-gdscript-addon@v3.2も個別に利用できます。

Unity 6 desktop Mono

Unity reusable workflowは配布済みGua UPM packageを配置し、指定したMono PlayerをGameCIでビルドして対象runnerへ渡し、GUA_UNITY_PLAYERを設定して外部NUnitテストを実行します。

.github/workflows/unity.ymlyaml
jobs:
  unity:
    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository
    uses: gua-project/gua-tester/.github/workflows/unity.yml@v3.2
    with:
      project-path: game
      scene-path: Assets/Scenes/Title.unity
      test-project: tests/GuaTester.Unity.Tests.csproj
      artifact-key: game
      platform: LinuxX64
      unity-version: auto
      gua-tag: gua-v1.1.1
    secrets:
      UNITY_EMAIL: ${{ secrets.UNITY_EMAIL }}
      UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
      UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
      UNITY_SERIAL: ${{ secrets.UNITY_SERIAL }}

必須inputはproject-path、scene-path、test-projectと、呼び出し元で一意なartifact-keyです。任意inputはunity-version、gua-repository、gua-tag、dotnet-version、configuration、test-logger、artifact-pathです。checkout-repositoryとcheckout-refを使うと、別repoのfixtureを検証できます。同じrunから複数回呼び出す場合はartifact-keyへmatrix値を指定します。

Personalライセンス

UNITY_EMAIL、UNITY_PASSWORD、UNITY_LICENSEを渡します。

Professionalライセンス

UNITY_EMAIL、UNITY_PASSWORD、UNITY_SERIALを渡します。

対応target

Unity 6000.5以降、Mono、4 RIDです。

artifact

Unity log、Player、TRX、diagnostics、Visual結果を保存します。

Visual差分レポート

gua-project/gua-tester/visual-report@v3.2は、Gua.Testing.VisualのmanifestとPNGをworkflow artifactまたはGitHub Pages向けの静的レポートへ変換します。Godot/Unity共通です。

失敗したVisual reportを保存yaml
- name: Upload visual report
  if: failure()
  uses: gua-project/gua-tester/visual-report@v3.2
  with:
    artifact-path: artifacts/gua
    test-outcome: failure
    upload-target: workflow

upload-target: pagesは信頼済みmainまたは手動実行だけで使用し、pages: writeとid-token: writeを持つ別jobからdeployします。

バージョンを固定する

Action/workflowはgua-project/gua-tester/...@v3.2を指定し、GuaのタグとNuGetは同じバージョンに合わせます。Godotテスト/UnityテストでテストAPIと追加パッケージを選びます。