docs: Add fork notes, changelog and notice
This commit is contained in:
@@ -0,0 +1,19 @@
|
||||
# Changelog
|
||||
|
||||
Fork-specific changes only. Upstream releases are documented at
|
||||
https://github.com/dermotduffy/advanced-camera-card/releases
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
Fork versions carry the upstream version they are built from plus a `+flan.N`
|
||||
build identifier.
|
||||
|
||||
## [8.0.2+flan.1] - 2026-09-04
|
||||
|
||||
### Added
|
||||
|
||||
- `cameras[].media.severities` restricts review media to the listed severities,
|
||||
so the thumbnail bar, media gallery and timeline can be pinned to Frigate
|
||||
alerts (`[high]`) instead of showing every detection. Resolved into the
|
||||
default query alongside `media.reviewed`, and overridden by an explicit
|
||||
severity chosen in the media filter drawer. Unset means all severities.
|
||||
@@ -0,0 +1,68 @@
|
||||
# Fork notes
|
||||
|
||||
A fork of [Advanced Camera Card](https://github.com/dermotduffy/advanced-camera-card),
|
||||
carrying one change on top of upstream `main`.
|
||||
|
||||
## What this fork adds
|
||||
|
||||
### `cameras[].media.severities`
|
||||
|
||||
Upstream issues review queries with no severity filter, so the thumbnail bar
|
||||
("side ribbon"), the media gallery and the timeline show every Frigate review
|
||||
item — alerts and detections alike — regardless of what a camera is configured
|
||||
to alert on. Severity can only be narrowed interactively, in the media filter
|
||||
drawer, and that choice does not persist.
|
||||
|
||||
`media.severities` restricts review media to the listed severities, resolved
|
||||
into the default query the same way `media.reviewed` already is:
|
||||
|
||||
```yaml
|
||||
type: custom:advanced-camera-card
|
||||
cameras:
|
||||
- camera_entity: camera.front_doorbell
|
||||
media:
|
||||
severities:
|
||||
- high
|
||||
```
|
||||
|
||||
| Value | Frigate equivalent |
|
||||
| -------- | ------------------ |
|
||||
| `high` | alert |
|
||||
| `medium` | detection |
|
||||
| `low` | (no equivalent) |
|
||||
|
||||
An explicit severity chosen in the media filter drawer still wins, so the
|
||||
interactive filter keeps working. Unset means all severities, so a config that
|
||||
does not mention `severities` behaves exactly as upstream does.
|
||||
|
||||
## Keeping up with upstream
|
||||
|
||||
```bash
|
||||
git remote add upstream https://github.com/dermotduffy/advanced-camera-card.git
|
||||
git fetch upstream
|
||||
git merge upstream/main
|
||||
yarn install --immutable && yarn typecheck && yarn lint && yarn test
|
||||
```
|
||||
|
||||
`dist/` is not committed (as upstream), so a merge should never conflict on
|
||||
build output.
|
||||
|
||||
## Releasing to HACS
|
||||
|
||||
HACS installs this card from **GitHub release assets**, not from the branch.
|
||||
That is not a preference — `gather_files_to_download()` in HACS
|
||||
(`custom_components/hacs/repositories/base.py`) skips every file under `dist/`
|
||||
whose basename does not start with `dist`, and this card's build emits a chunk
|
||||
named `dist-<hash>.js`. A branch install would therefore fetch that single
|
||||
chunk and nothing else.
|
||||
|
||||
To cut a release:
|
||||
|
||||
```bash
|
||||
RELEASE_VERSION=<version> yarn build
|
||||
gh release create <tag> dist/*.js --repo <mirror> --title <tag> --notes '...'
|
||||
```
|
||||
|
||||
Every file in `dist/` must be attached, `advanced-camera-card.js` included —
|
||||
HACS matches that name to decide the repository is release-based, then
|
||||
downloads all assets of the release.
|
||||
@@ -0,0 +1,10 @@
|
||||
This repository is a fork of Advanced Camera Card by Dermot Duffy:
|
||||
|
||||
https://github.com/dermotduffy/advanced-camera-card
|
||||
|
||||
Upstream code is used under the terms of the LICENSE file in this repository,
|
||||
which is unchanged from upstream. All upstream copyright remains with its
|
||||
authors.
|
||||
|
||||
Fork-specific changes (see FORK.md) were developed with AI assistance
|
||||
(Anthropic Claude).
|
||||
Reference in New Issue
Block a user