Files
Chronos/tests/visual/baselines/README.md
T
Alby96andClaude Opus 5.5 f2b58522b9
CI / Build and test (push) Successful in 8m14s
CI / Windows tests and installer (push) Skipped
CI / YAML check (push) Successful in 7s
Release / Build, test and publish (push) Successful in 13m19s
CI / PostgreSQL 16 integration (push) Successful in 4m49s
CI / PostgreSQL 17 integration (push) Successful in 5m28s
CI / Docker image (push) Successful in 53s
Release / Server image (push) Failing after 10s
refactor!: rename Titano to Chronos and move CI and releases to Gitea (#6)
The owner renamed the product and moved the repository to the self-hosted
Gitea (https://gitea.encke-hake.ts.net/BalboSoft/Chronos) for more control,
and asked for Actions and a first automatic release with the server package
and the Windows exe (docs/requests/2026-10-23-chronos-gitea.md).

- Chronos everywhere: a byte-exact rename of contents and paths, then a
  per-language review of the forms the old name's ending had dictated.
- Gitea instead of GitHub: the update check, licence, issue and support
  links read ChronosReleasesUrl; the update check takes the highest stable
  version, offers a pre-release build its final release and reports a
  repository it cannot see as a failed check. EULA, security policy and
  Gitea issue forms live at the repository root.
- Gitea Actions for the Linux act_runner (.gitea/workflows): CI, release,
  nightly image and performance gates in the .NET SDK container with git
  checkout and the system SQLite. The release cross-compiles the Windows
  programs, checks their icon, version and DPI manifest, packs installers
  and zips, publishes the Gitea release and pushes the server image
  (REGISTRY_TOKEN). Windows-only tests run in an opt-in job on a Windows
  runner (WINDOWS_RUNNER).
- New Chronos.Tools commands: zip, gitea-release, postgres-ci (replaces the
  docker-exec script, which Gitea's service containers do not allow; the
  throw-away server runs without durability) and pe-check.
- Timed tests take their budget from TestTiming (CHRONOS_TEST_TIME_FACTOR,
  3 on the shared runner; the weekly performance gates keep theirs).

BREAKING CHANGE: programs, settings, data folders, file types, environment
variables and the Docker image use the new name; nothing is migrated from
Titano, which never had a release.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Alberto Balbo <alberto.balbo.96@gmail.com>
2026-10-23 12:45:18 +02:00

55 lines
3.0 KiB
Markdown

# Screenshot baselines
The approved look of every screen, one PNG per `--capture` screenshot (`<screen>-<theme>.png`, as `Chronos.exe`,
`Chronos.Uploader.exe` and `Chronos.Setup.exe --capture <dir>` write them). CI compares each new screenshot with the
file of the same name here (BRIEF §20.2, visual regression with a pixel-diff tolerance):
```
dotnet run --project src/Chronos.Tools -- screenshots diff out/screenshots --out out/screenshot-diff
```
- A pixel differs when one of its channels moves by more than `--tolerance` (default 8 of 255); a screen fails when
more than `--max-diff` of its pixels differ (default 0.0005, that is 0.05 %), when its size changed, or when a
baseline here has no screenshot any more.
- A screenshot without a baseline fails as soon as this folder holds any PNG: a pull request that adds a screen adds its
baselines too.
- While this folder holds no PNG nothing is compared: the step passes, with a warning in the log saying that no visual
change can fail it.
- `out/screenshot-diff` gets `<screen>-diff.png` for every screen with differing pixels (the baseline faded to grey, the
differences magenta) and `summary.md`; they stay in the work folder of the Windows runner (Gitea Actions keeps no
artifacts here), and the job log lists every screen that failed.
## The pictures are reproducible
The capture runs on sample data whose clock stands at `SampleData.Now` (2026-10-02 10:18 UTC), in English with English
formats and with animations off, so the same code draws the same pixels on any day. Two things still come from the
machine:
- the time zone: times are shown in local time, and the baselines are made on the Windows runner of CI's `windows` job
(`WINDOWS_RUNNER`), which compares them in its own time zone;
- a few measured values: the server's response time and the time and duration of the last sync comparison. They change
a few dozen pixels, well inside the allowed fraction.
## Adding or updating baselines
Take them from CI, never from another PC (fonts, scaling and the time zone differ). On the Windows runner, every
same-repository pull request pushes its screenshots to the `ci-screenshots` branch (one commit, the PNGs at its root).
After checking them:
```
git fetch origin ci-screenshots
git worktree add ../ci-screenshots origin/ci-screenshots
dotnet run --project src/Chronos.Tools -- screenshots accept ../ci-screenshots
git worktree remove ../ci-screenshots
```
`screenshots accept <dir>` copies every PNG of `<dir>` here. Commit only the screens whose change is intended, and delete
the baseline of a screen that no longer exists.
## The first baselines
None is committed yet. Screenshots captured before the capture was made reproducible cannot serve: their times and
dates follow the moment they were taken (a job finished at "12:18 AM", sample sequences dated from that day). The first
baselines are accepted, all at once, from the `ci-screenshots` commit of the first green `windows` job run whose code
captures at `SampleData.Now`; from that commit on, every screen is gated.