Release Notes
4) Release Notes
Short description: How to create, publish, and format release notes for CJH releases.
Tags: release-notes, changelog, semantic-versioning, release-process
Markdown:
# Release Notes
This article defines a lightweight process and template for writing and publishing release notes for Creative Job Hub. Release notes help admins and tenant-owners understand new features, fixes, and migration requirements.
---
## Why release notes matter
- Communicate functional changes and bug fixes to administrators, dispatchers and technicians.
- Document any required tenant actions (e.g., run migrations, rotate tokens).
- Provide traceability and a quick rollback decision aid.
---
## Suggested release workflow
1. **Draft during the PR** — Encourage authors to add a short “release note” blurb to their PR description.
2. **Assemble per release** — The release manager collects PR blurbs and groups them by category (Added, Changed, Fixed, Security).
3. **Publish simultaneously with the release** — When you publish via Lovable or your CI/CD pipeline, publish release notes with the same tag/version.
---
## Release note format (recommended)
Use a standard, short and scannable format:
vX.Y.Z — YYYY-MM-DD
Added
- Short sentence describing the new feature (link to docs or KB if appropriate).
Changed
- Short sentence describing a behavior change.
Fixed
- Short sentence describing the bug fix and any workarounds.
Upgrade notes
- If any tenant actions required (DB migrations, token rotations, reconfigure Capacitor server.url), describe them here.
v1.7.0 — 2026-01-09
Added
- Properties inspection status: properties now show Due Soon/Overdue status in the Properties table.
Fixed
- Jobs Map: fixed cluster rendering bug for very large result sets.
Upgrade notes
- No action required.
Where to publish
- Project changelog (GitHub Releases) — tag the repo and add release notes.
- Internal release email / KB — publish the short release notes to tenant admins and link to the KB for details.
- Crisp KB — add a “Release Notes” article or list that links each version to the full notes.
Practical tips
- Be concise: Most readers skim; keep each item a single sentence with links to detail.
- Call out tenant actions clearly: Use a bold “Upgrade notes” section so admins know if manual steps are required.
- Keep an archive: Keep historical release notes accessible (GitHub Releases + KB).
Updated on: 10/01/2026
Thank you!