This workflow records completed user-visible changes while keeping release-cut editing efficient and accurate.
Add completed user-visible features and fixes to CHANGELOG.md under
Unreleased, keep the PR Release Notes Candidate aligned with that entry, and
consolidate the collected entries into a wider-audience summary under
docs/releases/ when cutting Beta/Stable releases.
These are the labels that actually exist on the repo (gh label list); apply
whichever fit, rather than inventing new ones.
- bug
- enhancement
- documentation
- maintenance
- area: refresh
- area: reader
- area: sidebar
- area: storage
- area: documentation
- area: build
- Open PRs against dev.
- Do not add a changelog entry while behavior is incomplete or speculative.
- When a user-visible feature or fix is complete, add one concise bullet under
Unreleased->FeaturesorFixes. - When the work has a canonical GitHub issue, append its exact URL using
[GH Issue #N](https://github.com/amatya-aditya/obsidian-rss-dashboard/issues/N). - Copy the final changelog wording into the PR Release Notes Candidate, or use
N/Afor internal-only refactors, tests, documentation, and tooling. - Apply labels for type and area.
- Do not edit
docs/releases/for an individual issue or feature. - After implementation and required validation succeed, close any matching
active plan using Plan Lifecycle and Archive.
Move an implemented plan to
docs/archive/plans/unreleased/, update its metadata and links, and add it to the archive catalog.
- Cut release/x.y.z from dev.
- Bump version on release branch only.
- Tag and publish Beta from release branch.
- Apply stabilization fixes on release branch.
- Treat the existing
Unreleasedsection as the primary release-note source. - Identify merged PRs between the previous tag and HEAD of the release branch
(
gh pr list --state merged, filtered to merge dates after the previous tag). - Cross-check each PR's user-visible behavior against
Unreleasedand add only genuinely missing entries. - Deduplicate and polish wording while preserving canonical GitHub issue URLs.
- Move the final entries into the new version heading, grouped by type and area.
- Create or update
docs/releases/<version>.mdas the public-facing summary. Consolidate related changelog bullets, lead with user impact, and omit implementation detail that does not help the wider audience. - Add or update the release line's curated What's New note at
src/release-notes/notes/<major.minor>.md. For a meaningful bug fix, an optional exact patch note may be added atsrc/release-notes/notes/<major.minor>.<patch>.md. Follow the curated note template. These notes are separate fromdocs/releases/<version>.md: shorter, written for the in-plugin popup, and embedded into the bundle at build time. A major/minor release with no line note failsnpm run check:pre-release; every note needs a valid filename, top-level heading, and HTTPS images with alt text. - Preserve granular issue URLs in
CHANGELOG.md. Include issue links in the public release summary only when they add useful context. - Exclude internal-only refactors unless they have direct user impact.
- Move release-bound implemented plans from
docs/archive/plans/unreleased/todocs/archive/plans/v<version>/; updatereleased_in, repository links, anddocs/archive/README.md.
List commits since previous tag:
git log --oneline 2.3.0-beta.1..HEADView changed files since previous tag:
git diff --name-only 2.3.0-beta.1..HEAD- Write user-facing wording in
CHANGELOG.mdwhen the behavior is complete. - Keep the PR Release Notes Candidate aligned with the changelog entry.
- Keep each PR focused so one PR maps to one release-note topic.
- Prefer short, specific bullets over long paragraphs.
- Update an existing matching bullet instead of adding a duplicate.
- Preserve the exact canonical issue URL so GitHub can create a cross-reference.
- Treat
CHANGELOG.mdas the granular record anddocs/releases/as the consolidated public narrative. - Final grouping, consolidation, and public wording polish happens at release cut time.
- Treat
docs/plans/as active work,docs/archive/README.mdas the historical catalog, and the development README as the plan-lifecycle source of truth.
Use this when implementation is complete and you want an LLM to draft commit and PR text from evidence.
Role:
You are a release-conscious maintainer drafting git metadata for an Obsidian plugin repo.
Context rules:
- Base branch is dev.
- Do not invent behavior, files, tests, or risk claims.
- Prefer user impact first, internal refactor second.
- If uncertain, explicitly mark uncertainty.
- Keep commit subject under 72 characters.
- Use imperative mood in commit subject.
- Include release-notes candidate text suitable for changelog curation.
Repository conventions:
- PR must include: summary, testing evidence, risk/rollback, release notes candidate.
- Completed user-visible changes are recorded under CHANGELOG.md > Unreleased.
- Release-cut curation deduplicates the changelog and produces the consolidated
public summary under docs/releases/.
- Labels expected: type, area.
Inputs:
- Branch name: <branch>
- Base branch: dev
- Changed files (name-status): <paste>
- Diff stat: <paste>
- Key diff hunks: <paste>
- Tests run + results: <paste>
- Known risks or edge cases: <paste or none>
- Related issues/PRs: <paste or none>
Output format:
1. Commit message
- Subject:
- Body:
- <bullet>
- <bullet>
2. PR title
- <title>
3. PR body
- Summary
- What changed
- User impact
- Testing
- Risk and rollback
- Release Notes Candidate
- Labels to apply (type, area)
Quality checks before final output:
- List every claim and map it to a file or test input.
- Remove any claim not supported by provided inputs.
- If no direct user impact, explicitly state: No direct user impact.
You are auditing the drafted commit and PR text.
Inputs:
- Original draft text: <paste draft>
- Changed files (name-status): <paste>
- Diff hunks: <paste>
- Test evidence: <paste>
Tasks:
1. Identify unsupported or speculative claims.
2. Flag missing risk notes for changed high-impact areas.
3. Flag vague wording and rewrite it concretely.
4. Return corrected final versions:
- Commit message
- PR title
- PR body
5. Keep release-notes candidate to 1-3 concise bullets.
Run these before using the prompt pack:
git status --short
git diff --name-status origin/dev...HEAD
git diff --stat origin/dev...HEAD
git diff origin/dev...HEADAlso include build/test command output used to validate the changes.