About
How the data is gathered
Once a day the server reads each app's releases from its official GitHub repository (api.github.com/repos/…/releases). A per-app rule, fixed in code and tested against saved copies of real release notes, picks out two kinds of text:
- a section under a heading the vendor uses for breaking changes (for example
### 🚨 Breaking Changes), up to the next heading of the same level; - a GitHub note marked
[!WARNING],[!CAUTION]or[!IMPORTANT], with a code block that directly follows it.
That text is shown as written, with a link to the release it came from. Nothing on a result page is written or summarised by this site; the only words added are labels such as “Breaking” and the counts at the top.
Where a vendor publishes a separate upgrade guide for a major version (Paperless-ngx docs/migration-v3.md), each section of that guide is quoted in full, labelled “Upgrade guide”, on routes that reach that version.
Required stops are different: they are researched by hand from the vendor's own documentation and stored with the source link and the date checked. A stop is listed only when the vendor states it.
What is covered
- Immich: github.com/immich-app/immich/releases
- Paperless-ngx: github.com/paperless-ngx/paperless-ngx/releases
- Frigate: github.com/blakeblackshear/frigate/releases
- Gitea: github.com/go-gitea/gitea/releases
Pre-releases and release candidates are left out. A change the vendor did not mark as breaking will not appear here, so the full release notes are always linked.
Reporting a mistake
If a quote is wrong, a breaking change is missing, or a required stop is wrong or missing, say which page and what upstream says. Reports are read and fixed by hand; there is no reply.
Until a fix is out, the upstream release linked next to every quote is the authority: if this site and the release notes disagree, the release notes are right.