|
| 1 | +--- |
| 2 | +name: prepare-release |
| 3 | +description: Prepare a new release by updating CHANGELOG.md with changes since the last tag and bumping version numbers in pyproject.toml and ui/package.json |
| 4 | +--- |
| 5 | + |
| 6 | +# Prepare Release |
| 7 | + |
| 8 | +When preparing a release, follow these steps: |
| 9 | + |
| 10 | +## 1. Fetch tags and identify the last release |
| 11 | + |
| 12 | +```bash |
| 13 | +git fetch --tags |
| 14 | +git tag --sort=-creatordate | head -5 |
| 15 | +``` |
| 16 | + |
| 17 | +## 2. Get commits since the last release |
| 18 | + |
| 19 | +```bash |
| 20 | +git log --oneline <last-tag>..HEAD |
| 21 | +``` |
| 22 | + |
| 23 | +## 3. Read current files |
| 24 | + |
| 25 | +Read these files to understand current state: |
| 26 | +- `CHANGELOG.md` - to understand the format and existing entries |
| 27 | +- `pyproject.toml` - to get current version |
| 28 | +- `ui/package.json` - to get current UI version |
| 29 | + |
| 30 | +## 4. Update CHANGELOG.md |
| 31 | + |
| 32 | +- Add a new version section at the top (below the `# Changelog` header) |
| 33 | +- Organize changes into categories: |
| 34 | + - **Breaking Changes** - API changes that require user action |
| 35 | + - **New Features** - New functionality |
| 36 | + - **Internal Improvements** - Refactoring, tests, tooling |
| 37 | +- Use bold headers for each change group |
| 38 | +- Use bullet points for details |
| 39 | +- If there was an "Unreleased" section, rename it to the previous version |
| 40 | + |
| 41 | +## 5. Bump versions |
| 42 | + |
| 43 | +Update the version string in: |
| 44 | +- `pyproject.toml` - the `version` field under `[project]` |
| 45 | +- `ui/package.json` - the `"version"` field |
| 46 | + |
| 47 | +Use semantic versioning: |
| 48 | +- Patch (0.0.x) for bug fixes |
| 49 | +- Minor (0.x.0) for new features |
| 50 | +- Major (x.0.0) for breaking changes |
| 51 | + |
| 52 | +## 6. Summary |
| 53 | + |
| 54 | +After completing, summarize what was updated: |
| 55 | +- New version number |
| 56 | +- Key changes added to changelog |
| 57 | +- Files modified |
0 commit comments