Skip to content

Commit 28e28d5

Browse files
committed
refactori api
1 parent c82fff9 commit 28e28d5

59 files changed

Lines changed: 1390 additions & 818 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

RELEASE.md

Lines changed: 88 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ cd ..
1919

2020
This regenerates Python and TypeScript clients from `openapi.json`.
2121

22+
**Note:** Your `pyproject.toml` and `package.json` are preserved - only code is regenerated.
2223

2324
### 3. Commit Everything
2425

@@ -34,8 +35,94 @@ git commit -m "Update OpenAPI spec and regenerate clients"
3435
```
3536

3637
This will:
37-
- Update versions in all core components
38+
- Update version to `0.0.6` in **all** components (core, clients, CLI, UI, Helm)
3839
- Commit changes
3940
- Create and push tag `v0.0.6`
4041
- Trigger GitHub Actions (builds Python package, Rust CLI, Docker images, Helm chart)
4142

43+
---
44+
45+
## After GitHub Actions Complete
46+
47+
### Publish Python Client to PyPI
48+
49+
```bash
50+
cd memora-clients/python
51+
uv build
52+
uv publish
53+
```
54+
55+
### Publish TypeScript Client to NPM
56+
57+
```bash
58+
cd memora-clients/typescript
59+
npm install
60+
npm run build
61+
npm publish --access public
62+
```
63+
64+
---
65+
66+
## Pre-Release Checklist
67+
68+
- [ ] Tests passing: `cd memora && uv run pytest tests`
69+
- [ ] No uncommitted changes: `git status`
70+
- [ ] On `main` branch
71+
72+
---
73+
74+
## Versioning
75+
76+
**Semantic Versioning: `MAJOR.MINOR.PATCH`**
77+
78+
- **PATCH** (0.0.6): Bug fixes, no API changes
79+
- **MINOR** (0.1.0): New features, backward compatible
80+
- **MAJOR** (1.0.0): Breaking changes
81+
82+
**All components use the same version** - coordinated releases for simplicity.
83+
84+
---
85+
86+
## Troubleshooting
87+
88+
**Tag already exists:**
89+
```bash
90+
git tag -d v0.0.6
91+
git push origin :refs/tags/v0.0.6
92+
```
93+
94+
**Working directory not clean:**
95+
```bash
96+
git status
97+
# Commit or stash changes first
98+
```
99+
100+
**GitHub Actions failed:**
101+
- Check: https://github.com/nicoloboschi/memora/actions
102+
- Re-run failed jobs or fix and release new patch version
103+
104+
**Rollback:**
105+
```bash
106+
git tag -d v0.0.6
107+
git push origin :refs/tags/v0.0.6
108+
git revert HEAD
109+
git push
110+
```
111+
112+
---
113+
114+
## Quick Reference
115+
116+
```bash
117+
# Full release workflow
118+
uv sync
119+
cd memora-dev && uv run generate-openapi && cd ..
120+
./scripts/generate-clients.sh
121+
git add openapi.json memora-clients/
122+
git commit -m "Update OpenAPI spec and regenerate clients"
123+
./scripts/release.sh 0.0.6
124+
125+
# After GH Actions complete:
126+
cd memora-clients/python && uv build && uv publish
127+
cd ../typescript && npm run build && npm publish --access public
128+
```

0 commit comments

Comments
 (0)