docs: add release notes workflow (#29)

* fix: cap per-user audit capacity

Block new audits before a user exceeds the temporary 100k audit footprint cap. Surface a clear delete-old-audits message in the audit launch UI.

* fix: reserve audit capacity with Drizzle

* chore: prepare 0.0.2 release notes

* docs: add release notes workflow
This commit is contained in:
Ben Senescu 2026-03-16 14:56:10 -04:00 committed by GitHub
parent 4524a94887
commit 3700e16a7c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 32 additions and 0 deletions

View File

@ -28,4 +28,5 @@ After reviewing the generated notes:
- confirm the `package.json` version matches the intended release tag when one is provided
- tighten wording only when it improves clarity
- preserve the existing section structure unless there is a strong reason to merge sections
- suggest saving the finalized notes to `release-notes/v<version>.md` when a version is known
- suggest a `gh release create` command if the user wants to publish next

View File

@ -39,6 +39,18 @@ The generator:
- groups the remaining changes into short user-facing sections
- can create a draft GitHub release when `--draft` is provided
Store finalized notes in `release-notes/` as versioned Markdown files such as `release-notes/v0.0.2.md`.
Recommended release flow:
```sh
pnpm -s release:notes
# edit and save the final copy in release-notes/v0.0.2.md
gh release create v0.0.2 --target main --title v0.0.2 --notes-file release-notes/v0.0.2.md
```
For now, prefer patch releases while the project is still in rapid early development unless there is a clear reason to cut a minor or major release.
## OpenCode slash command
For convenience inside OpenCode, use:

13
release-notes/README.md Normal file
View File

@ -0,0 +1,13 @@
# Release Notes
Store finalized release notes in this folder as versioned Markdown files.
Recommended naming:
- `release-notes/v0.0.2.md`
Typical flow:
1. Generate a draft with `pnpm -s release:notes`.
2. Copy the final edited notes into a versioned file in this folder.
3. Publish with `gh release create <tag> --title <tag> --notes-file release-notes/<tag>.md`.

6
release-notes/v0.0.2.md Normal file
View File

@ -0,0 +1,6 @@
## Added
- Support keyword research in many more countries.
- Created the official Docker image CD.
Full Changelog: https://github.com/bensenescu/open-seo/compare/v0.0.1...main