diff --git a/.opencode/command/release-notes.md b/.opencode/command/release-notes.md index c2e4f30..55382f8 100644 --- a/.opencode/command/release-notes.md +++ b/.opencode/command/release-notes.md @@ -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.md` when a version is known - suggest a `gh release create` command if the user wants to publish next diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 127cc6f..97cbc50 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -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: diff --git a/release-notes/README.md b/release-notes/README.md new file mode 100644 index 0000000..06b29c6 --- /dev/null +++ b/release-notes/README.md @@ -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 --title --notes-file release-notes/.md`. diff --git a/release-notes/v0.0.2.md b/release-notes/v0.0.2.md new file mode 100644 index 0000000..3162477 --- /dev/null +++ b/release-notes/v0.0.2.md @@ -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