Repository navigation
ci cd
All automation lives in .github/workflows. Three workflows keep the project healthy and
publish its artifacts and documentation.
| Property | Value |
|---|---|
| Triggers | Push to master, pull requests, manual dispatch |
| Runners |
windows-latest, ubuntu-latest, macos-latest
|
| Steps | Restore, build (Release), test, upload test results and coverage on each OS |
| Inspection | A separate inspectcode job runs jb inspectcode on windows-latest and fails on any finding |
The build matrix runs on all three desktop platforms, so platform-specific code is compiled and
tested everywhere. The build runs the Meziantou and Roslynator analyzers and is expected to stay
warning-free, so a green CI run means zero compiler and analyzer warnings. The inspectcode job
adds the JetBrains inspection gate: the run must report zero findings.
Test results (*.trx) and coverage output are uploaded as per-platform artifacts
(test-results-<os> and code-coverage-<os>).
| Property | Value |
|---|---|
| Triggers | Push of a release_* or v* tag, or manual dispatch with a tag input |
| Runners |
windows-latest (verify), plus one package job per target platform |
| Permissions | contents: write |
Flow:
-
verify - builds and runs the full test suite on
windows-latest. -
package - publishes single-file, framework-dependent builds (
--self-contained false,-p:PublishSingleFile=true,-p:IncludeNativeLibrariesForSelfExtract=true) for six runtime identifiers and creates:Platform Runtime identifiers Bundle Windows win-x64,win-arm64release_<version>_<rid>.zipLinux linux-x64,linux-arm64release_<version>_<rid>.tar.gzmacOS osx-x64,osx-arm64release_<version>_<rid>.dmgA
.sha256checksum file is created for every bundle. Windows zips contain the single-fileRomValidator.exeplus7za.exeand7za_arm64.exe. Linux archives contain the single-file executable, marked executable before packaging. macOS disk images containROM Validator.appwith an ad-hoc signature and app icon. Every bundle also includesLICENSE.txt,ReadMe.mdandWhatsNew.md; debug symbols and XML documentation are excluded. -
release - checks out the repository history, then creates a GitHub release for the tag and attaches all bundles and checksums, with automatically generated release notes.
git tag release_3.0.1
git push origin release_3.0.1The version in the bundle names comes from the tag (release_ or a leading v is stripped). This
naming convention is compatible with the in-app update check, which parses tags such as
release_3.0.1 and v3.0.1. Keep the tag in sync with AssemblyVersion / FileVersion in
RomValidator.csproj.
A manual dispatch of the workflow with the tag input can be used to re-publish an existing tag.
| Property | Value |
|---|---|
| Triggers | Push to master that changes docs/** or the workflow itself, manual dispatch |
| Permissions |
contents: write, pages: write, id-token: write
|
The pages job builds this documentation with Jekyll (using the
just-the-docs theme) and deploys it with the
official GitHub Pages actions:
-
actions/configure-pages- enables Pages with the "GitHub Actions" source when needed. -
actions/jekyll-build-pages- buildsdocs/into_site/. -
actions/upload-pages-artifact+actions/deploy-pages- publishes the site.
The site is available at https://purelogiccode.github.io/RomValidator/.
One-time setup
If the Pages site has never been enabled, open Settings > Pages and select GitHub Actions as the source, or let
configure-pagesenable it on the first run.
The wiki job runs .github/scripts/publish-wiki.sh, which:
- clones
<repository>.wiki.git, - strips YAML front matter from every
docs/*.mdpage and copies the content to the wiki (index.mdbecomesHome.md), - generates
_Sidebar.mdfrom the page titles and sections, - commits and pushes only when something changed.
The wiki clone and push require a token that is allowed to write to the wiki repository. Create a
repository secret named WIKI_TOKEN (classic personal access token with the repo scope) to
guarantee this. If the secret is absent, the workflow falls back to GITHUB_TOKEN; on
repositories where GITHUB_TOKEN cannot push to the wiki the job emits a warning and skips the
sync instead of failing.
First wiki page
A wiki repository does not exist until the first page has been created in the GitHub UI. Open the Wiki tab once and save a page, then run the workflow again.