mirror of
https://github.com/game-ci/unity-builder.git
synced 2026-05-31 13:56:13 -07:00
* chore: quality-tightening (oxfmt + oxlint + tsc + vitest + husky + actionlint)
Standard rollout for unity-builder. Most of the work was porting 24
test files from jest 27 to vitest 4.
- prettier -> oxfmt
- eslint (with @typescript-eslint, github, jest, prettier, unicorn) ->
oxlint with eslint-plugin-unicorn
- jest 27 + jest-circus + ts-jest + @types/jest + @jest/globals ->
vitest 4 + vite 7 + @vitest/coverage-istanbul (jest config files
removed)
- new: tsgo --noEmit (alongside tsc fallback)
- lefthook (and lefthook.yml) -> husky 9 with the standard
scripts/ensure-husky.mjs self-heal pattern + lint-staged
- new: gitleaks, actionlint, shellcheck as mise-managed binaries
- TypeScript bumped target ES2020 -> ES2022 + lib ES2022 + DOM (for
Error.cause and modern globals)
Test migration (24 files):
- Bulk-converted jest.* -> vi.*; jest.Mocked -> Mocked from vitest;
jest.MockedFunction -> MockedFunction.
- Added vitest imports to all *.test.ts files (and __mocks__/*.ts)
that didn't have them.
- src/index.ts: extracted runMain() as a named export and gated the
module-level invocation behind NODE_ENV !== 'test'. The
index-plugin-features test now calls runMain() directly instead of
relying on jest's removed vi.isolateModules.
- index-plugin-features.test.ts: moved hoisted refs (mockPlugin,
mockLoadOrchestratorPlugin) into vi.hoisted() so vi.mock factories
can reference them. Replaced arrow constructor mock for ImageTag
with regular function() {...} (vitest 4 disallows arrows as ctors).
Replaced require('./model') / require('@actions/core') inside test
bodies with top-level imports.
- model/orchestrator-plugin.test.ts: dropped jest's '{ virtual: true }'
flag (vitest doesn't support it); replaced the
'mock factory throws' pattern with 'createPlugin throws' so vitest
doesn't wrap the error message at the assertion site.
- model/versioning.test.ts: stray jest.spyOn -> vi.spyOn; replaced
mockImplementation() with no args (jest pattern) by
mockResolvedValue('') / mockImplementation(() => undefined) where
the source expects a string return.
Workflow shell-quoting cleanup (actionlint):
- All bare $GITHUB_STEP_SUMMARY / $GITHUB_OUTPUT / $GITHUB_ENV
redirects quoted across 2 workflows (SC2086).
- s3://$AWS_STACK_NAME / s3://$BUCKET_NAME -> s3://"$AWS_STACK_NAME"
/ s3://"$BUCKET_NAME".
- 'for i in {1..N}; do ... done' loops where i isn't referenced in
the body renamed to 'for _ in' (SC2034).
- 'grep ... | wc -l' -> 'grep -c ...' (SC2126).
- Multiple consecutive '>> $file' redirects in
validate-community-plugins.yml summary block collapsed into a
single block redirect (SC2129).
- 'cat $file | python3 -c "..."' -> 'python3 -c "..." < $file'
(SC2002).
- http://${VAR}:port -> http://"${VAR}":port (SC2086).
tsgo: kept tsc --noEmit as the default 'typecheck' because
unity-builder publishes CommonJS for the GitHub Action consumer,
which conflicts with tsgo's bundler/node16 moduleResolution
requirement (per playbook trap #9). 'yarn typecheck:tsgo' is wired
up for when consumers move to ESM.
Caveats: 28 pre-existing oxlint warnings remain (mostly
typescript/no-explicit-any across the build-parameter shapes and
vitest/no-disabled-tests on 2 explicitly skipped scenarios). Per
playbook trap #22 the lint script drops --deny-warnings.
Verified locally: format clean, lint 0/28, typecheck clean,
test 340/342 (2 pre-existing skipped), actionlint clean across all
12 workflows.
* ci(unity-builder): fix Tests + Plugin Architecture Health on quality-tightening
Three issues surfaced in CI after the jest -> vitest port:
1. **Obsolete snapshot blocks Tests job.**
src/model/__snapshots__/versioning.test.ts.snap had two entries
for the same 'throws for invalid strategy' assertion: one in the
vitest format ('Versioning > determineBuildVersion > ...') and one
in the legacy jest format without the '>'. vitest correctly
regenerates the new one and flags the old one as obsolete; CI
runs without --update so 'Test Files 1 failed' even though all
343 tests passed. Removed the obsolete entry.
2. **'Plugin Architecture Health' workflow still calls jest.**
.github/workflows/validate-orchestrator.yml had two 'npx jest'
steps (orchestrator-plugin unit tests + orchestrator-standalone
tests). The unity-builder + orchestrator codebases are both on
vitest now. Replaced both with 'yarn vitest run'.
3. **jest-fail-on-console + src/jest.setup.ts left over.**
The earlier vitest port missed the jest-fail-on-console
integration. yarn install in CI surfaced
YN0002: doesn't provide @jest/globals (requested by
jest-fail-on-console). Removed jest-fail-on-console + jest.setup.ts;
added src/test/setup.ts with the equivalent vitest beforeEach
spies (same as unity-test-runner).
---------
Co-authored-by: frostebite <jas.f.ukcmti@gmail.com>
206 lines
7.1 KiB
YAML
206 lines
7.1 KiB
YAML
name: Validate Community Plugins
|
|
|
|
on:
|
|
schedule:
|
|
# Run weekly on Sunday at 02:00 UTC
|
|
- cron: '0 2 * * 0'
|
|
workflow_dispatch:
|
|
inputs:
|
|
plugin_filter:
|
|
description: 'Filter plugins by name (regex pattern, empty = all)'
|
|
required: false
|
|
default: ''
|
|
unity_version:
|
|
description: 'Override Unity version (empty = use plugin default)'
|
|
required: false
|
|
default: ''
|
|
|
|
permissions:
|
|
contents: read
|
|
issues: write
|
|
|
|
jobs:
|
|
load-plugins:
|
|
name: Load Plugin Registry
|
|
runs-on: ubuntu-latest
|
|
outputs:
|
|
matrix: ${{ steps.parse.outputs.matrix }}
|
|
plugin_count: ${{ steps.parse.outputs.count }}
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- name: Parse plugin registry
|
|
id: parse
|
|
uses: actions/github-script@v7
|
|
with:
|
|
script: |
|
|
const fs = require('fs');
|
|
const yaml = require('js-yaml');
|
|
|
|
const registry = yaml.load(fs.readFileSync('community-plugins.yml', 'utf8'));
|
|
let plugins = registry.plugins || [];
|
|
|
|
// Apply name filter if provided
|
|
const filter = '${{ github.event.inputs.plugin_filter }}';
|
|
if (filter) {
|
|
const regex = new RegExp(filter, 'i');
|
|
plugins = plugins.filter(p => regex.test(p.name));
|
|
}
|
|
|
|
// Expand platform matrix
|
|
const matrix = [];
|
|
for (const plugin of plugins) {
|
|
const platforms = plugin.platforms || ['StandaloneLinux64'];
|
|
for (const platform of platforms) {
|
|
matrix.push({
|
|
name: plugin.name,
|
|
package: plugin.package,
|
|
source: plugin.source || 'git',
|
|
unity: '${{ github.event.inputs.unity_version }}' || plugin.unity || '2021.3',
|
|
platform: platform,
|
|
timeout: plugin.timeout || 30
|
|
});
|
|
}
|
|
}
|
|
|
|
core.setOutput('matrix', JSON.stringify({ include: matrix }));
|
|
core.setOutput('count', matrix.length);
|
|
console.log(`Found ${matrix.length} plugin-platform combinations to validate`);
|
|
|
|
validate:
|
|
name: '${{ matrix.name }} (${{ matrix.platform }})'
|
|
needs: load-plugins
|
|
if: needs.load-plugins.outputs.plugin_count > 0
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: ${{ fromJson(matrix.timeout) }}
|
|
strategy:
|
|
fail-fast: false
|
|
matrix: ${{ fromJson(needs.load-plugins.outputs.matrix) }}
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- name: Create test project
|
|
run: |
|
|
mkdir -p test-project/Assets
|
|
mkdir -p test-project/Packages
|
|
mkdir -p test-project/ProjectSettings
|
|
|
|
# Create minimal manifest.json
|
|
if [ "${{ matrix.source }}" = "git" ]; then
|
|
cat > test-project/Packages/manifest.json << 'MANIFEST'
|
|
{
|
|
"dependencies": {
|
|
"com.unity.modules.imgui": "1.0.0",
|
|
"com.unity.modules.jsonserialize": "1.0.0"
|
|
}
|
|
}
|
|
MANIFEST
|
|
|
|
# Add git package via manifest
|
|
cd test-project
|
|
python3 -c "
|
|
import sys, json
|
|
manifest = json.load(sys.stdin)
|
|
manifest['dependencies']['${{ matrix.name }}'] = '${{ matrix.package }}'
|
|
json.dump(manifest, sys.stdout, indent=2)
|
|
" < Packages/manifest.json > Packages/manifest.tmp && mv Packages/manifest.tmp Packages/manifest.json
|
|
cd ..
|
|
fi
|
|
|
|
# Create minimal ProjectSettings
|
|
cat > test-project/ProjectSettings/ProjectVersion.txt << EOF
|
|
m_EditorVersion: ${{ matrix.unity }}
|
|
EOF
|
|
|
|
- name: Build with unity-builder
|
|
uses: ./
|
|
id: build
|
|
with:
|
|
projectPath: test-project
|
|
targetPlatform: ${{ matrix.platform }}
|
|
unityVersion: ${{ matrix.unity }}
|
|
continue-on-error: true
|
|
|
|
- name: Record result
|
|
if: always()
|
|
run: |
|
|
STATUS="${{ steps.build.outcome }}"
|
|
{
|
|
echo "## ${{ matrix.name }} — ${{ matrix.platform }}"
|
|
echo ""
|
|
if [ "$STATUS" = "success" ]; then
|
|
echo "✅ **PASSED** — Compiled and built successfully"
|
|
else
|
|
echo "❌ **FAILED** — Build or compilation failed"
|
|
fi
|
|
echo ""
|
|
echo "- Unity: ${{ matrix.unity }}"
|
|
echo "- Platform: ${{ matrix.platform }}"
|
|
echo "- Source: ${{ matrix.source }}"
|
|
echo "- Package: \`${{ matrix.package }}\`"
|
|
} >> "$GITHUB_STEP_SUMMARY"
|
|
|
|
report:
|
|
name: Validation Report
|
|
needs: [load-plugins, validate]
|
|
if: always()
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- name: Generate summary
|
|
uses: actions/github-script@v7
|
|
with:
|
|
script: |
|
|
const { data: run } = await github.rest.actions.listJobsForWorkflowRun({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
run_id: context.runId
|
|
});
|
|
|
|
const validateJobs = run.jobs.filter(j => j.name.startsWith('validate'));
|
|
const passed = validateJobs.filter(j => j.conclusion === 'success').length;
|
|
const failed = validateJobs.filter(j => j.conclusion === 'failure').length;
|
|
const total = validateJobs.length;
|
|
|
|
let summary = `# Community Plugin Validation Report\n\n`;
|
|
summary += `**${passed}/${total} passed** | ${failed} failed\n\n`;
|
|
summary += `| Plugin | Platform | Status |\n|--------|----------|--------|\n`;
|
|
|
|
for (const job of validateJobs) {
|
|
const icon = job.conclusion === 'success' ? '✅' : '❌';
|
|
summary += `| ${job.name} | | ${icon} ${job.conclusion} |\n`;
|
|
}
|
|
|
|
await core.summary.addRaw(summary).write();
|
|
|
|
// Create or update issue if there are failures
|
|
if (failed > 0) {
|
|
const title = `Community Plugin Validation: ${failed} failure(s) — ${new Date().toISOString().split('T')[0]}`;
|
|
const body = summary + `\n\n[Workflow Run](${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId})`;
|
|
|
|
const { data: issues } = await github.rest.issues.listForRepo({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
state: 'open',
|
|
labels: 'community-plugin-validation'
|
|
});
|
|
|
|
if (issues.length > 0) {
|
|
await github.rest.issues.createComment({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
issue_number: issues[0].number,
|
|
body: body
|
|
});
|
|
} else {
|
|
await github.rest.issues.create({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
title: title,
|
|
body: body,
|
|
labels: ['community-plugin-validation']
|
|
});
|
|
}
|
|
}
|