@@ -15,10 +15,16 @@ Create a stable release using the automated justfile target with comprehensive v
1515You are an expert release manager for the Basic Memory project. When the user runs ` /release ` , execute the following steps:
1616
1717### Step 1: Pre-flight Validation
18- 1 . Verify version format matches ` v\d+\.\d+\.\d+ ` pattern
19- 2 . Check current git status for uncommitted changes
20- 3 . Verify we're on the ` main ` branch
21- 4 . Confirm no existing tag with this version
18+
19+ #### Version Check
20+ 1 . Check current version in ` src/basic_memory/__init__.py `
21+ 2 . Verify new version format matches ` v\d+\.\d+\.\d+ ` pattern
22+ 3 . Confirm version is higher than current version
23+
24+ #### Git Status
25+ 1 . Check current git status for uncommitted changes
26+ 2 . Verify we're on the ` main ` branch
27+ 3 . Confirm no existing tag with this version
2228
2329#### Documentation Validation
24301 . ** Changelog Check**
@@ -39,19 +45,83 @@ The justfile target handles:
3945- ✅ Version update in ` src/basic_memory/__init__.py `
4046- ✅ Automatic commit with proper message
4147- ✅ Tag creation and pushing to GitHub
42- - ✅ Release workflow trigger
48+ - ✅ Release workflow trigger (automatic on tag push)
49+
50+ The GitHub Actions workflow (` .github/workflows/release.yml ` ) then:
51+ - ✅ Builds the package using ` uv build `
52+ - ✅ Creates GitHub release with auto-generated notes
53+ - ✅ Publishes to PyPI
54+ - ✅ Updates Homebrew formula (stable releases only)
4355
4456### Step 3: Monitor Release Process
45- 1 . Check that GitHub Actions workflow starts successfully
46- 2 . Monitor workflow completion at: https://github.com/basicmachines-co/basic-memory/actions
47- 3 . Verify PyPI publication
48- 4 . Test installation: ` uv tool install basic-memory `
57+ 1 . Verify tag push triggered the workflow (should start automatically within seconds)
58+ 2 . Monitor workflow progress at: https://github.com/basicmachines-co/basic-memory/actions
59+ 3 . Watch for successful completion of both jobs:
60+ - ` release ` - Builds package and publishes to PyPI
61+ - ` homebrew ` - Updates Homebrew formula (stable releases only)
62+ 4 . Check for any workflow failures and investigate logs if needed
4963
5064### Step 4: Post-Release Validation
51- 1 . Verify GitHub release is created automatically
52- 2 . Check PyPI publication
53- 3 . Validate release assets
54- 4 . Update any post-release documentation
65+
66+ #### GitHub Release
67+ 1 . Verify GitHub release is created at: https://github.com/basicmachines-co/basic-memory/releases/tag/ <version >
68+ 2 . Check that release notes are auto-generated from commits
69+ 3 . Validate release assets (` .whl ` and ` .tar.gz ` files are attached)
70+
71+ #### PyPI Publication
72+ 1 . Verify package published at: https://pypi.org/project/basic-memory/ <version >/
73+ 2 . Test installation: ` uv tool install basic-memory `
74+ 3 . Verify installed version: ` basic-memory --version `
75+
76+ #### Homebrew Formula (Stable Releases Only)
77+ 1 . Check formula update at: https://github.com/basicmachines-co/homebrew-basic-memory
78+ 2 . Verify formula version matches release
79+ 3 . Test Homebrew installation: ` brew install basicmachines-co/basic-memory/basic-memory `
80+
81+ #### Website Updates
82+
83+ ** 1. basicmachines.co** (` /Users/drew/code/basicmachines.co ` )
84+ - ** Goal** : Update version number displayed on the homepage
85+ - ** Location** : Search for "Basic Memory v0." in the codebase to find version displays
86+ - ** What to update** :
87+ - Hero section heading that shows "Basic Memory v{VERSION}"
88+ - "What's New in v{VERSION}" section heading
89+ - Feature highlights array (look for array of features with title/description)
90+ - ** Process** :
91+ 1 . Pull latest from GitHub: ` git pull origin main `
92+ 2 . Create release branch: ` git checkout -b release/v{VERSION} `
93+ 3 . Search codebase for current version number (e.g., "v0.16.1")
94+ 4 . Update version numbers to new release version
95+ 5 . Update feature highlights with 3-5 key features from this release (extract from CHANGELOG.md)
96+ 6 . Commit changes: ` git commit -m "chore: update to v{VERSION}" `
97+ 7 . Push branch: ` git push origin release/v{VERSION} `
98+ - ** Deploy** : Follow deployment process for basicmachines.co
99+
100+ ** 2. docs.basicmemory.com** (` /Users/drew/code/docs.basicmemory.com ` )
101+ - ** Goal** : Add new release notes section to the latest-releases page
102+ - ** File** : ` src/pages/latest-releases.mdx `
103+ - ** What to do** :
104+ 1 . Pull latest from GitHub: ` git pull origin main `
105+ 2 . Create release branch: ` git checkout -b release/v{VERSION} `
106+ 3 . Read the existing file to understand the format and structure
107+ 4 . Read ` /Users/drew/code/basic-memory/CHANGELOG.md ` to get release content
108+ 5 . Add new release section ** at the top** (after MDX imports, before other releases)
109+ 6 . Follow the existing pattern:
110+ - Heading: ` ## [v{VERSION}](github-link) — YYYY-MM-DD `
111+ - Focus statement if applicable
112+ - ` <Info> ` block with highlights (3-5 key items)
113+ - Sections for Features, Bug Fixes, Breaking Changes, etc.
114+ - Link to full changelog at the end
115+ - Separator ` --- ` between releases
116+ 7 . Commit changes: ` git commit -m "docs: add v{VERSION} release notes" `
117+ 8 . Push branch: ` git push origin release/v{VERSION} `
118+ - ** Source content** : Extract and format sections from CHANGELOG.md for this version
119+ - ** Deploy** : Follow deployment process for docs.basicmemory.com
120+
121+ ** 4. Announce Release**
122+ - Post to Discord community if significant changes
123+ - Update social media if major release
124+ - Notify users via appropriate channels
55125
56126## Pre-conditions Check
57127Before starting, verify:
@@ -74,13 +144,18 @@ Before starting, verify:
74144🏷️ Tag: v0.13.2
75145📋 GitHub Release: https://github.com/basicmachines-co/basic-memory/releases/tag/v0.13.2
76146📦 PyPI: https://pypi.org/project/basic-memory/0.13.2/
147+ 🍺 Homebrew: https://github.com/basicmachines-co/homebrew-basic-memory
77148🚀 GitHub Actions: Completed
78149
79- Install with:
80- uv tool install basic-memory
150+ Install with pip/uv:
151+ uv tool install basic-memory
152+
153+ Install with Homebrew:
154+ brew install basicmachines-co/basic-memory/basic-memory
81155
82156Users can now upgrade:
83- uv tool upgrade basic-memory
157+ uv tool upgrade basic-memory
158+ brew upgrade basic-memory
84159```
85160
86161## Context
@@ -89,4 +164,6 @@ uv tool upgrade basic-memory
89164- Uses the automated justfile target for consistency
90165- Version is automatically updated in ` __init__.py `
91166- Triggers automated GitHub release with changelog
92- - Leverages uv-dynamic-versioning for package version management
167+ - Package is published to PyPI for ` pip ` and ` uv ` users
168+ - Homebrew formula is automatically updated for stable releases
169+ - Supports multiple installation methods (uv, pip, Homebrew)
0 commit comments