mirror of
https://github.com/Matysh/houseplan-card
synced 2026-07-31 16:38:31 +00:00
67 lines
4.5 KiB
Markdown
67 lines
4.5 KiB
Markdown
# Project status & session context
|
|
|
|
> **Purpose of this file.** Cowork/AI sessions lose context (overflow, new session).
|
|
> This file is the **first thing to read** when resuming work. It captures the current
|
|
> state, where everything lives, and how to continue safely.
|
|
>
|
|
> **Documentation policy (mandatory):** every change is documented *in the same
|
|
> commit* — CHANGELOG entry for anything user-visible, STATUS.md for state changes
|
|
> (versions, publication, infrastructure), DEVELOPMENT.md for new gotchas,
|
|
> ARCHITECTURE.md for design changes, ROADMAP.md when plans move.
|
|
|
|
## Snapshot (2026-07-05)
|
|
|
|
| Item | State |
|
|
|---|---|
|
|
| Version | **v1.11.2** everywhere (manifest, const.py, package.json, CARD_VERSION) |
|
|
| GitHub | https://github.com/Matysh/houseplan-card — branch `main`, releases v1.9.3…v1.11.2 |
|
|
| CI | `.github/workflows/validate.yml` (hacs + hassfest + frontend + backend) — **fully green** since v1.11.1; `release.yml` auto-attaches the card bundle (needs `permissions: contents: write`, fixed) |
|
|
| HACS | Works as custom repository (id 1290210112 on the home instance). **Inclusion PR: https://github.com/hacs/default/pull/8995** (queue ≈2 months as of 2026-07) |
|
|
| Brands | Ships **inside the integration**: `custom_components/houseplan/brand/{icon,icon@2x,logo,logo@2x}.png` (HA ≥2026.3 local-brands mechanism). home-assistant/brands PR #10700 was auto-closed — that repo no longer accepts custom integrations |
|
|
| Home instance | ha.jbstudio.pro (SSH port 323, key `ha_jb`), deployed v1.11.2, installed *via HACS* (custom repo) — updates flow through HACS now |
|
|
| Localization | UI en/ru (`src/i18n.ts`), auto by `hass.locale` + `language` card option; codebase and docs are English-first (`README.ru.md` is the Russian copy) |
|
|
| Tests | 15 frontend (node:test on logic/rules) + 10 backend (pytest on validation.py) |
|
|
|
|
## Recent milestones (details in CHANGELOG.md)
|
|
|
|
- **v1.10.0** — audit & refactor: asyncio.Lock around all store writes (race fix, atomic
|
|
`expected_rev`), point `layout/update` instead of full `layout/set` (anti last-writer-wins),
|
|
new `layout/delete`, `safeUrl()` XSS guard, `fetchWithAuth`, KEY_HASS, streaming upload cap,
|
|
card split into modules (`styles.ts` / `types.ts` / `devices.ts`), dynamic spaces in the GUI
|
|
editor, dead code removed.
|
|
- **v1.11.0** — full English translation + en/ru UI localization.
|
|
- **v1.11.1** — brand images inside the integration; CI fully green for the first time.
|
|
- **v1.11.2** — Description textarea fix in the device dialog.
|
|
|
|
## Where things live
|
|
|
|
- **Source of truth:** the git repo (GitHub `main`). In a sandbox session: clone from GitHub or
|
|
from `houseplan-card.git.bundle` (kept fresh in the user folder root *and* in `houseplan-card/`).
|
|
- **User folder** `houseplan/houseplan-card/` — a file mirror of the repo (synced after every
|
|
commit; the mount cannot delete files, so a few stale artifacts linger — git is authoritative).
|
|
- **Production config:** server-side on the HA instance, `.storage/houseplan.config` +
|
|
`.storage/houseplan.layout` (backups `.bak-v1100` exist on the box).
|
|
|
|
## Open items / watchlist
|
|
|
|
1. **hacs/default PR #8995** — waiting for moderation (bot may draft the PR for minor fixes —
|
|
fix and re-ready; wrongly filled template ⇒ silent close).
|
|
2. GitHub PAT `houseplan-card-publish` (repo+workflow) expires ~2026-07-12; in sandbox
|
|
`~/.git-credentials`. Revoke after the HACS queue clears, or re-issue when needed.
|
|
3. Stale files on the mount that cannot be deleted from the sandbox: `src/data/` leftovers,
|
|
`brand_preview.png`, old nested bundle copies — ignore, git is authoritative.
|
|
4. Roadmap next: see ROADMAP.md (quality-scale conformance is the next big theme).
|
|
|
|
## How to resume work in a fresh session (checklist)
|
|
|
|
1. Read this file, then CHANGELOG.md (top entries), DEVELOPMENT.md (environment gotchas).
|
|
2. Restore the repo: `git clone <user-folder>/houseplan-card.git.bundle hpcN` in `/tmp`
|
|
(files from *previous* sandbox sessions in `/tmp` belong to `nobody` and are unreadable —
|
|
always clone into a fresh directory; `npm ci` again).
|
|
3. Deployment needs the `ha_jb` SSH key — ask the user to upload it (uploads are readable
|
|
only in the session they were uploaded in).
|
|
4. Build only in `/tmp` (never on the mount), `npm run build` (starts with `tsc --noEmit`),
|
|
md5-verify after every deploy, restart HA via
|
|
`nohup ha core restart >/dev/null 2>&1 </dev/null &` (otherwise the SSH session hangs).
|
|
5. GitHub pushes need a PAT (create via the user's Chrome: settings/tokens, repo+workflow scope).
|