Contributing
Perch is a .NET 10 app with an Avalonia UI. The code is at github.com/ArcticGizmo/perch.
Build and run
Section titled “Build and run”You need the .NET 10 SDK.
dotnet build perch.slnxOn Windows the app project builds for two targets, so dotnet run needs the Windows one named:
dotnet run --project src/Perch.App -f net10.0-windows10.0.19041.0 # Windowsdotnet run --project src/Perch.App # macOSA Debug build runs as an isolated dev instance with its own settings and a pink border, so it can sit next to an installed Perch without the two interfering.
dotnet test tests/Perch.Tests/Perch.Tests.csprojAfter changing install.ps1, also run the installer tests:
powershell -NoProfile -File tools\test-install.ps1Warnings are treated as errors in every project, so fix a new warning rather than suppressing it.
Previewing UI changes
Section titled “Previewing UI changes”Most of Perch’s UI is drawn by hand. To check a change without launching the tray, render every surface to PNG at 1× and 1.5×:
dotnet run --project src/Perch.App -f net10.0-windows10.0.19041.0 -- render out # Windowsdotnet run --project src/Perch.App -- render out # macOSAdd a theme id as a third argument to render under a different theme.
This site
Section titled “This site”The site lives in site/ and is built with
Astro Starlight. The changelog, privacy page and install.ps1 are copied in
from the repo root at build time, so edit the root files, not the copies.
cd sitenpm cinpm run devPushing to main deploys it.
Releasing
Section titled “Releasing”Releases are built by GitHub Actions when a version tag is pushed:
- Bump
<Version>insrc/Perch.App/Perch.App.csproj. - Commit the change.
- Push a matching tag, for example
git tag v0.6.0 && git push origin v0.6.0.
The workflow builds and packages both platforms, writes SHA256SUMS.txt over the exact files it uploads, and
publishes them to the GitHub Release. Installed copies pick the release up through Check for Updates….
Checksums prove the bytes you ran are the bytes that were published. They aren’t a signature: the manifest sits
on the same release as the installer. Code signing is the fix for that, and is tracked in
docs/distribution-plan.md.
