Document headless linking, dedicated identity and alpha status

- README: SSH-tunnel and QR-as-file linking for headless servers
- README: dedicated-number registration path for a separate bot identity
- README: alpha-quality notice, provenance caveat, non-affiliation
- add CHANGELOG.md (Keep a Changelog, everything under Unreleased)
- AGENTS.md: require Unreleased changelog entries
This commit is contained in:
2026-11-18 17:06:18 +00:00
parent f97d0f2e09
commit f6d0db664e
3 changed files with 161 additions and 9 deletions
+52
View File
@@ -0,0 +1,52 @@
# Changelog
All notable changes to this project are documented in this file. The format
follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the
project will use [Semantic Versioning](https://semver.org/) once it starts
releasing.
No stable release has been made yet: every change accumulates under
Unreleased. To make the first release, rename that section to
`## [0.1.0] - YYYY-MM-DD` and start a fresh Unreleased above it.
## [Unreleased]
### Added
- iCalendar feed polling with conditional requests (ETag/Last-Modified);
validators are only committed after a successful parse.
- Event parsing and expansion, including The Events Calendar series detection:
announcements are deduplicated per series, not per occurrence.
- Two posts per event: an announcement when it is first seen, and a reminder
three days before it starts, with a morning-of fallback for events added
less than three days ahead.
- Preferred posting windows with an urgent guard that posts early rather than
after the event has started.
- Batched sending: everything due in a window becomes one message.
- Poster images from the feed's `ATTACH` property, falling back to the event
page's `og:image` / JSON-LD; images are downscaled, cached and attached as
base64 data URIs.
- Event-page scraping for venue name and postcode, cached per URL.
- Watchdog alerts to the operator's own number when the feed or sending fails.
- CLI with run loop, `--once`, `--dump` and `--check`.
- Docker Compose setup pairing the bot with `signal-cli-rest-api`, including
headless device-linking and dedicated-number registration instructions.
- Offline test suite; AGENTS.md; GPL-3.0-or-later licensing; provenance
disclaimer.
### Changed
- Renamed from `calbot` to `signal-cal-bot`: Python package
`signal_cal_bot`, CLI `signal-cal-bot`, environment variables
`SIGNAL_CAL_BOT_*`, database `data/signal-cal-bot.sqlite3`.
### Fixed
- Connection errors while sending no longer bypass the watchdog.
- Image decoding failures, including decompression bombs, can no longer block
the text post or wedge the outbox.
- Reminders are dropped for events removed from the feed, using the feed's
coverage horizon so the 30-event export cap does not cancel future events.
- Transparent images are composited onto white instead of turning black.
- `--dump` uses a temporary database and no longer touches real state.
- Duplicate postcode no longer appears when the venue name already contains it.