docs: release notes format and patch notes for v2.0.0-beta to v2.4.0-beta

This commit is contained in:
fsylvain committed 2026-09-30 03:11:37 +02:00
1 parent 142325730d
commit e0fa433ff9
6 files changed
+193

No files matched your search

+28
View File
@@ -0,0 +1,28 @@
# Release notes format
Name: `vX.Y.Z-beta - Short theme` (theme is 2 to 6 words, sentence case).
Tag: `vX.Y.Z-beta`, always with the `v`.
Body, in this order. Omit a section only when it would be empty, except Upgrading, which is always present.
1. Intro: one or two plain sentences on what the release is about. No heading.
2. `## New`: user-visible features. Group with a bold title line (`**Group name**`) followed by bullets.
3. `## Improvements and fixes`: flat bullets.
4. `## API`: one bullet per endpoint change, `METHOD /v1/path` in backticks, then behaviour and status codes. Prefix breaking or shape changes with "Changed:".
5. `## Under the hood`: dependencies, tests, docs, architecture. Only when relevant to contributors.
6. `## Upgrading`: binary replacement, schema/migration changes, new env vars, behaviour changes for existing installs.
7. `## Known limitations`: only when there are real ones.
Rules: bullets are full sentences ending with a period; user-facing wording, no commit prefixes; sentence-case headings; no horizontal rules, no metadata block, no "Pre-1.0" boilerplate (the prerelease flag says it); every release ships all 6 binaries from `task release`.
## Published releases
Each body lives in `docs/releases/<tag>.md`. Publish with `tea releases create --tag <tag> --title "<name>" --note-file docs/releases/<tag>.md --prerelease --asset <binary>` (one `--asset` per binary), after `task release`.
| Tag | Name |
| --- | --- |
| `2.0.0-beta` (legacy tag without the `v`, kept as is) | v2.0.0-beta - Vue 3 SPA and domain-driven backend |
| `v2.1.0-beta` | v2.1.0-beta - Image upload in the editor |
| `v2.2.0-beta` | v2.2.0-beta - Image crop, image removal & reset screens |
| `v2.3.0-beta` | v2.3.0-beta - Multi-user invitations, display names & profile page |
| `v2.4.0-beta` | v2.4.0-beta - Owner role, invite management & Settings page |
+28
View File
@@ -0,0 +1,28 @@
A ground-up rewrite of RenewCMS's backend architecture and frontend. The Go-template UI is replaced by a Vue 3 single-page app embedded in the same binary.
## New
**Vue 3 single-page app**
- Built with Vite, Pinia and vue-router, and embedded into the single binary. There is no separate frontend deployment.
- The UI uses Nuxt UI (migrated from an initial PrimeVue base) with shared design tokens.
- New screens: login, registration, home and navigation, article list, article editor (ProseMirror-based) with a creation modal, image upload, and an account and integration screen.
- A typed API client and a session store handle 401, unverified 403, 429 and offline states the same way everywhere.
**Domain-driven backend**
- `internal/domain` (entities, sentinel errors, repository interfaces) is isolated from persistence (GORM), mailer and API concerns, with a strict inward dependency rule.
- Business logic moved out of handlers and the persistence layer into use cases: article rules, image validation, password and code hashing, not-found handling, and session invalidation on password reset.
- The composition root (`api/dependecyInjection.go`) wires the database, repositories and use cases explicitly. Runtime settings are read once at startup.
- The auth handler is split into dedicated registration, login, verification and password-reset handlers, each with per-client rate limiting on the public routes.
## Improvements and fixes
- API responses no longer leak password hashes, verification or reset code hashes, or their expiry dates.
- Article read rules now apply the same way to the single-article and list endpoints: the public sees online articles only, verified users also see offline ones.
- Registration only opens when no verified account exists, and deleting a user frees its username and email for reuse.
- Rate limiting now keys off the real peer IP.
## Under the hood
- Use cases are covered by a full in-memory fake test suite with clean gremlins mutation coverage.
- Vitest and Vue Test Utils run the frontend tests, and an automated visual-parity check compares the app to the design source boards.
## Upgrading
- Deployment is unchanged: a single binary, systemd and a reverse proxy. Replace the binary and restart.
+20
View File
@@ -0,0 +1,20 @@
This release adds image upload to the article editor and fixes several rough edges from v2.0.0-beta.
## New
**Image upload in the article editor**
- The editor's Image toolbar button, or dropping a file onto the editor, opens an upload dialog.
- Choose or drop a PNG, JPEG, WEBP or SVG file up to 10 MB. Progress is shown live, and the image is inserted at the cursor as soon as it is uploaded.
- Invalid files (wrong type or too large) are rejected in the browser before anything is sent. The same wording is reused if the server rejects a file the browser let through.
- A failed upload leaves the article untouched and offers a retry.
## Improvements and fixes
- Uploaded images now render in the editor and the article body. The dev server proxy was missing a route for the endpoint that serves them.
- Clicking a row in the article list now opens the editor. The row-click handler was reading the wrong argument.
- The article details panel's copy URL control now copies the link and confirms with a toast.
- The user menu's dropdown trigger no longer misrenders when the sidebar is collapsed.
- The sidebar's collapsed or expanded state is remembered across reloads.
- Smaller styling and layout fixes in the article details panel, editor toolbar and new-article dialog.
## Upgrading
- Replace the binary and restart.
+32
View File
@@ -0,0 +1,32 @@
This release reworks image handling in the article editor and brings the password-reset screens up to the new design.
## New
**Crop and resize before upload**
- A Crop and resize step now sits between picking an image and uploading it. It applies to JPEG, PNG and WEBP files. SVG files still upload straight away.
- Move or resize the crop frame by dragging it or its handles. Arrow keys nudge it by 1 px, and Shift+arrow resizes it by 1 px.
- Aspect ratios: Original, Free, 16:9, 4:3 and 1:1.
- Rotate and Reset buttons.
- Output width presets: Original, 1600 px (default), 1200 px and 800 px. The output is never wider than the crop frame.
- A live line shows the final pixel size and an approximate file size before you upload.
**Remove images from the editor**
- Images in an article can now be removed from the editor. The image file and its database row are both deleted.
- The editor renders images as a dedicated image node.
**Password-reset screens**
- The Forgot password and Reset password screens follow the new design and cover every state in the spec.
## API
- `DELETE /v1/article/{id}/image/{imageId}` (authenticated) deletes an image. It returns 204 on success, 404 for an unknown article or image, and 400 for an ID that isn't a valid uint32.
- Changed: `POST /v1/article/{id}/image` now returns `{"id": …, "location": …}` instead of `{"location": …}`. The change is additive, but anything parsing the response strictly should be checked.
## Under the hood
- The editor now depends on `@tiptap/extension-image`, `@tiptap/pm` and `@tiptap/vue-3`, all pinned to 3.31.3.
- New feature specs and QA procedures cover crop and resize, image removal and both reset screens.
- New Go HTTP tests cover image deletion, and Vitest specs were added and updated for the editor and reset views.
- The visual-check states cover the new screens, and the design docs are updated to match.
## Upgrading
- No new environment variables and no schema changes.
- Replace the binary and restart.
+43
View File
@@ -0,0 +1,43 @@
RenewCMS is no longer a one-person tool. The admin can now invite other people, each with their own account and the exact same access, and everyone can set a display name.
## New
**Invite other users**
- A new Users page in the back-office lists everyone who can sign in, plus pending and expired invites, with a status badge for each.
- Invite user sends an email with a personal link. The link works once and expires after 3 days.
- Invited people choose their own username and password on a new Accept invite screen, and land on Home already logged in.
- Everyone shares one workspace: same articles, same images, same access.
- Registration stays closed to everyone who wasn't invited.
- A new invitation email template supports light and dark mode.
**Display name and profile**
- A new Profile page is opened from the account menu at the bottom of the sidebar.
- Set an optional display name (up to 60 characters). It replaces your username in the sidebar, the account menu, the Home greeting, the Users list and the emails RenewCMS sends. Clear it to go back to your username.
- Send yourself a password reset link from the Profile page.
- The account chip now opens a menu with Profile and Log out, and keeps the System, Light and Dark theme choice.
## Improvements and fixes
- Accepting an invite is atomic: two simultaneous requests with the same link can only create one account.
- The Accept invite screen shows a retry option instead of a permanent spinner when the invite can't be loaded.
- Invite email validation is now the same in the browser and on the server.
- The mobile account sheet reports its open state correctly and returns focus to the account chip when it closes.
- A failed password reset email is now logged on the server. The response is unchanged.
## API
- `PATCH /v1/user/me` sets the display name.
- `GET /v1/auth/me` and `POST /v1/auth/verify` now return `display_name`.
- `GET /v1/user/` lists users and invites.
- `POST /v1/user/invite` sends an invite and is rate limited.
- `GET /v1/auth/invite` and `POST /v1/auth/invite/accept` power the Accept invite screen.
## Under the hood
- Deleting a user now goes through the persistence model.
## Upgrading
- Download the binary for your platform, replace the old one and restart. Your `.env` and SQLite file stay as they are.
- The database migrates itself on startup. It adds a `display_name` column to `users` and a new `invites` table. Existing data is untouched. Back up your SQLite file first as a precaution.
- Invitation emails need working SMTP settings, like the verification and reset emails already do. No new environment variables.
## Known limitations
- Users and invites can't be removed, revoked or resent yet, and there are no roles: everybody is an equal admin.
- Invited addresses that already have an account are rejected. An expired invite can be replaced by sending a new one.
+42
View File
@@ -0,0 +1,42 @@
RenewCMS now knows who owns the workspace. The owner manages invites, including cancelling and renewing them, while every admin keeps the same access to content. A new Settings page shows which build is running.
## New
**Owner and admin roles**
- The first registered account is the owner. Everyone who joins through an invite is an admin.
- Only the owner can send, cancel or renew invites. Admins keep the same access to articles, images, the Users list, their Profile and Settings.
- There is exactly one owner. Roles can't be changed or transferred yet.
- Existing installs are migrated automatically: the oldest account becomes the owner and every other account an admin.
**Invite management**
- Pending invites get a Cancel invite action on the Users page. The invite link stops working.
- Expired invites get a Renew invite action. It sends a new email with a new personal link valid for 3 days, and the old link stays dead.
**Users list**
- The Users table and the mobile card list now show Email, Display name (a dash when empty), Role, Invite status and Created.
- A new role badge tells the owner and admins apart.
**Settings page**
- A new Settings page at `/settings` sits after Integration in the sidebar and the mobile drawer. It shows the version of the running build.
## Improvements and fixes
- The desktop account menu's icons, labels and check mark are now centred in their 32 px rows.
- The account menu follows the redesigned board: System, Light and Dark stay in both the menu and the mobile sheet.
- The article editor's toolbar scrolls horizontally on mobile instead of overflowing.
- The editor's last-saved label now moves from minutes to hours and days instead of counting minutes only.
## API
- `DELETE /v1/user/invite/{id}` cancels a pending invite and returns 204.
- `POST /v1/user/invite/{id}/renew` returns 200 with a new code, sets `expires_at` to now plus 3 days and `created_at` to now, and resends the invitation email.
- Changed: `POST /v1/user/invite` is now owner-only, like the two endpoints above. Other users get 403 with "Only the owner can do this."
- `GET /v1/settings` (authenticated, verified users) returns the running build's version.
- Changed: user objects from `GET /v1/user/`, `GET /v1/auth/me` and `POST /v1/auth/verify` now include `role` (`owner` or `admin`).
## Upgrading
- Replace the binary and restart. Your `.env` and SQLite file stay as they are.
- The database migrates itself on startup. It adds a `role` column to `users` and fills it in: the account with the lowest id becomes the owner, every other account an admin. A database that already has roles is left unchanged. Back up your SQLite file first as a precaution.
- Behaviour change: admins who joined through a v2.3.0-beta invite can no longer send invites.
- No new environment variables.
## Known limitations
- No endpoint changes or transfers the owner role, and users can't be removed yet.