Skip to content

Commit 7d4a6fc

Browse files
committed
chore: add delivery pipeline and ceplugin template
Complete the release-facing repository shape after the modular client layers are in place. The solution now replaces the legacy Binding project with Core, publishes the template package and a Native AOT compatibility probe, adds package/template smoke scripts, and updates CI into reusable main and pull-request workflows. The canonical ceplugin template demonstrates explicit JSON configuration, DI modules, safe Lua module registration, direct SDK reference requirements, and managed-plugin deployment. The root documentation and ADR set now describe the package graph, activation lifecycle, capability gates, delivery policy, and local authorized-process boundary. Validation: - dotnet build CheatEngine.Client.slnx --configuration Release --no-restore --warnaserror - dotnet test --solution CheatEngine.Client.slnx --configuration Release --no-build --no-restore --report-trx --results-directory artifacts/test-results --fail-skips on - dotnet pack CheatEngine.Client.slnx --configuration Release --no-build --no-restore --output artifacts/packages - eng/Invoke-PackageSmoke.ps1 -PackageSource artifacts/packages - eng/Invoke-TemplateSmoke.ps1 -PackageSource artifacts/packages - dotnet publish tests/CheatEngine.Client.AotProbe/CheatEngine.Client.AotProbe.csproj --configuration Release --runtime win-x64 --no-restore --output artifacts/aot-probe - artifacts/aot-probe/CheatEngine.Client.AotProbe.exe
1 parent eee9be3 commit 7d4a6fc

32 files changed

Lines changed: 1761 additions & 150 deletions

‎.github/workflows/build.yml‎

Lines changed: 0 additions & 54 deletions
This file was deleted.

‎.github/workflows/ci.yml‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
name: Client validation
2+
3+
on:
4+
workflow_call:
5+
6+
permissions:
7+
contents: read
8+
9+
defaults:
10+
run:
11+
shell: pwsh
12+
13+
env:
14+
DOTNET_NOLOGO: true
15+
DOTNET_CLI_TELEMETRY_OPTOUT: true
16+
MSBUILDDISABLENODEREUSE: true
17+
18+
jobs:
19+
validate:
20+
name: Validate packages, template, and AOT graph
21+
runs-on: windows-latest
22+
timeout-minutes: 35
23+
24+
steps:
25+
- name: Checkout
26+
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
27+
with:
28+
fetch-depth: 0
29+
persist-credentials: false
30+
31+
- name: Install pinned .NET SDK
32+
uses: actions/setup-dotnet@a98b56852c35b8e3190ac28c8c2271da59106c68 # v6.0.0
33+
with:
34+
global-json-file: global.json
35+
cache: true
36+
cache-dependency-path: |
37+
**/packages.lock.json
38+
Directory.Packages.props
39+
40+
- name: Restore locked dependency graph
41+
run: dotnet restore CheatEngine.Client.slnx --locked-mode
42+
43+
- name: Build Release
44+
run: dotnet build CheatEngine.Client.slnx --configuration Release --no-restore --warnaserror
45+
46+
- name: Run unit tests through Microsoft Testing Platform
47+
run: >-
48+
dotnet test --solution CheatEngine.Client.slnx --configuration Release --no-build --no-restore
49+
--report-trx --results-directory artifacts/test-results --fail-skips on
50+
51+
- name: Summarize test results
52+
if: ${{ !cancelled() }}
53+
run: |
54+
$reports = @(Get-ChildItem -Path artifacts/test-results -Filter *.trx -Recurse -File -ErrorAction SilentlyContinue)
55+
if ($reports.Count -eq 0) {
56+
Write-Host '::warning::The test run produced no TRX report.'
57+
return
58+
}
59+
60+
$results = @($reports | ForEach-Object {
61+
([xml](Get-Content -LiteralPath $_.FullName -Raw)).TestRun.Results.UnitTestResult
62+
} | Where-Object { $_ })
63+
$passed = @($results | Where-Object outcome -eq 'Passed').Count
64+
$skipped = @($results | Where-Object outcome -eq 'NotExecuted').Count
65+
$failed = @($results | Where-Object { $_.outcome -notin 'Passed', 'NotExecuted' })
66+
67+
@(
68+
'### Test results',
69+
'',
70+
'| Total | Passed | Failed | Skipped |',
71+
'| ---: | ---: | ---: | ---: |',
72+
"| $($results.Count) | $passed | $($failed.Count) | $skipped |"
73+
) | Out-File -FilePath $env:GITHUB_STEP_SUMMARY -Append -Encoding utf8
74+
75+
- name: Upload test results
76+
if: ${{ !cancelled() }}
77+
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
78+
with:
79+
name: test-results
80+
path: artifacts/test-results/**/*.trx
81+
if-no-files-found: warn
82+
retention-days: 14
83+
84+
- name: Pack and validate public package APIs
85+
run: dotnet pack CheatEngine.Client.slnx --configuration Release --no-build --no-restore
86+
87+
- name: Smoke test isolated package consumption
88+
shell: pwsh
89+
run: ./eng/Invoke-PackageSmoke.ps1 -PackageSource ./artifacts/packages
90+
91+
- name: Smoke test local template installation
92+
run: ./eng/Invoke-TemplateSmoke.ps1 -PackageSource ./artifacts/packages
93+
94+
- name: Upload package artifacts
95+
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
96+
with:
97+
name: nuget-packages
98+
path: |
99+
artifacts/packages/*.nupkg
100+
artifacts/packages/*.snupkg
101+
if-no-files-found: error
102+
retention-days: 14
103+
104+
- name: Publish Native AOT reference probe
105+
run: dotnet publish tests/CheatEngine.Client.AotProbe/CheatEngine.Client.AotProbe.csproj --configuration Release --runtime win-x64 --no-restore --output ./artifacts/aot-probe
106+
107+
- name: Run Native AOT reference probe
108+
run: ./artifacts/aot-probe/CheatEngine.Client.AotProbe.exe
109+
110+
- name: Upload Native AOT probe
111+
if: ${{ !cancelled() }}
112+
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
113+
with:
114+
name: native-aot-probe
115+
path: artifacts/aot-probe
116+
if-no-files-found: warn
117+
retention-days: 14
118+
119+
gate:
120+
name: Gate
121+
if: ${{ always() }}
122+
needs: validate
123+
runs-on: windows-latest
124+
timeout-minutes: 5
125+
permissions: {}
126+
127+
steps:
128+
- name: Check validation result
129+
env:
130+
VALIDATE_RESULT: ${{ needs.validate.result }}
131+
run: |
132+
"| Job | Result |", "| --- | --- |", "| validate | $env:VALIDATE_RESULT |" |
133+
Out-File -FilePath $env:GITHUB_STEP_SUMMARY -Append -Encoding utf8
134+
if ($env:VALIDATE_RESULT -ne 'success') {
135+
Write-Host "::error::Validation finished with '$env:VALIDATE_RESULT'."
136+
exit 1
137+
}

‎.github/workflows/main-ci.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Main CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- '.editorconfig'
8+
- '.github/**'
9+
- 'CheatEngine.Client.slnx'
10+
- 'Directory.Build.props'
11+
- 'Directory.Build.targets'
12+
- 'Directory.Packages.props'
13+
- 'README.md'
14+
- 'eng/**'
15+
- 'global.json'
16+
- 'libs/**'
17+
- 'src/**'
18+
- 'templates/**'
19+
- 'tests/**'
20+
merge_group:
21+
types: [checks_requested]
22+
workflow_dispatch:
23+
24+
concurrency:
25+
group: ${{ github.workflow }}-${{ github.ref }}
26+
cancel-in-progress: false
27+
28+
permissions:
29+
contents: read
30+
31+
jobs:
32+
ci:
33+
name: CI
34+
uses: ./.github/workflows/ci.yml
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Pull request CI
2+
3+
on:
4+
pull_request:
5+
types: [opened, synchronize, reopened, ready_for_review]
6+
paths:
7+
- '.editorconfig'
8+
- '.github/**'
9+
- 'CheatEngine.Client.slnx'
10+
- 'Directory.Build.props'
11+
- 'Directory.Build.targets'
12+
- 'Directory.Packages.props'
13+
- 'README.md'
14+
- 'eng/**'
15+
- 'global.json'
16+
- 'libs/**'
17+
- 'src/**'
18+
- 'templates/**'
19+
- 'tests/**'
20+
21+
concurrency:
22+
group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
23+
cancel-in-progress: true
24+
25+
permissions:
26+
contents: read
27+
28+
jobs:
29+
ci:
30+
name: CI
31+
if: github.event.pull_request.draft == false
32+
uses: ./.github/workflows/ci.yml
33+
34+
lint-workflows:
35+
name: Lint workflows
36+
if: github.event.pull_request.draft == false
37+
runs-on: windows-latest
38+
timeout-minutes: 5
39+
env:
40+
ACTIONLINT_VERSION: 1.7.12
41+
ACTIONLINT_SHA256: 6e7241b51e6817ea6a047693d8e6fed13b31819c9a0dd6c5a726e1592d22f6e9
42+
43+
steps:
44+
- name: Checkout workflow definitions
45+
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
46+
with:
47+
sparse-checkout: .github
48+
persist-credentials: false
49+
50+
- name: Run actionlint
51+
run: |
52+
$ErrorActionPreference = 'Stop'
53+
$archive = Join-Path $env:RUNNER_TEMP 'actionlint.zip'
54+
$url = "https://github.com/rhysd/actionlint/releases/download/v$env:ACTIONLINT_VERSION/actionlint_$($env:ACTIONLINT_VERSION)_windows_amd64.zip"
55+
Invoke-WebRequest -Uri $url -OutFile $archive -MaximumRetryCount 3 -RetryIntervalSec 5
56+
57+
$actual = (Get-FileHash -LiteralPath $archive -Algorithm SHA256).Hash.ToLowerInvariant()
58+
if ($actual -ne $env:ACTIONLINT_SHA256) {
59+
throw "actionlint $env:ACTIONLINT_VERSION has SHA-256 $actual, expected $env:ACTIONLINT_SHA256."
60+
}
61+
62+
$destination = Join-Path $env:RUNNER_TEMP 'actionlint'
63+
Expand-Archive -LiteralPath $archive -DestinationPath $destination
64+
& (Join-Path $destination 'actionlint.exe') -color

‎CheatEngine.Client.slnx‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,31 @@
1111
</Folder>
1212
<Folder Name="/eng/">
1313
<File Path="eng/Shipping.props"/>
14+
<File Path="eng/Templates.props"/>
1415
<File Path="eng/Tests.props"/>
1516
</Folder>
1617
<Folder Name="/libs/">
1718
<Project Path="libs/CheatEngine.Client.Abstractions/CheatEngine.Client.Abstractions.csproj"/>
18-
<Project Path="libs/CheatEngine.Client.Binding/CheatEngine.Client.Binding.csproj"/>
19+
<Project Path="libs/CheatEngine.Client.Core/CheatEngine.Client.Core.csproj"/>
20+
<Project
21+
Path="libs/CheatEngine.Client.Extensions.DependencyInjection/CheatEngine.Client.Extensions.DependencyInjection.csproj"/>
1922
<Project Path="libs/CheatEngine.Client.Fluent/CheatEngine.Client.Fluent.csproj"/>
23+
<Project Path="libs/CheatEngine.Client.Hosting/CheatEngine.Client.Hosting.csproj"/>
2024
</Folder>
2125
<Folder Name="/src/">
2226
<Project Path="src/CheatEngine.Client/CheatEngine.Client.csproj"/>
2327
</Folder>
2428
<Folder Name="/tests/">
2529
<Project Path="tests/CheatEngine.Client.Abstractions.Tests/CheatEngine.Client.Abstractions.Tests.csproj"/>
26-
<Project Path="tests/CheatEngine.Client.Binding.Tests/CheatEngine.Client.Binding.Tests.csproj"/>
30+
<Project Path="tests/CheatEngine.Client.AotProbe/CheatEngine.Client.AotProbe.csproj"/>
31+
<Project Path="tests/CheatEngine.Client.Core.Tests/CheatEngine.Client.Core.Tests.csproj"/>
32+
<Project
33+
Path="tests/CheatEngine.Client.Extensions.DependencyInjection.Tests/CheatEngine.Client.Extensions.DependencyInjection.Tests.csproj"/>
2734
<Project Path="tests/CheatEngine.Client.Fluent.Tests/CheatEngine.Client.Fluent.Tests.csproj"/>
35+
<Project Path="tests/CheatEngine.Client.Hosting.Tests/CheatEngine.Client.Hosting.Tests.csproj"/>
2836
<Project Path="tests/CheatEngine.Client.Tests/CheatEngine.Client.Tests.csproj"/>
2937
</Folder>
38+
<Folder Name="/templates/">
39+
<Project Path="templates/CheatEngine.Client.Templates/CheatEngine.Client.Templates.csproj"/>
40+
</Folder>
3041
</Solution>

0 commit comments

Comments
 (0)