Skip to content

Commit eaa1d18

Browse files
Copilothuangyiirene
Copilot
and
huangyiirene
committed
docs: add release notes for v0.2.0
Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
1 parent d1762dc commit eaa1d18

1 file changed

Lines changed: 155 additions & 0 deletions

File tree

‎RELEASE_NOTES_v0.2.0.md‎

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
# Release Notes for Object UI v0.2.0
2+
3+
## Release Preparation Completed ✅
4+
5+
This document contains instructions for completing the release of Object UI version 0.2.0.
6+
7+
## What Has Been Done
8+
9+
### 1. Version Updates ✅
10+
All 11 packages have been updated from version `0.1.0` to `0.2.0`:
11+
- `@object-ui/types`
12+
- `@object-ui/core`
13+
- `@object-ui/react`
14+
- `@object-ui/components`
15+
- `@object-ui/designer`
16+
- `@object-ui/cli`
17+
- `@object-ui/data-objectql`
18+
- `@object-ui/plugin-charts`
19+
- `@object-ui/plugin-editor`
20+
- `@object-ui/plugin-kanban`
21+
- `@object-ui/plugin-markdown`
22+
23+
### 2. CHANGELOG.md Updated ✅
24+
The CHANGELOG.md has been updated to:
25+
- Move unreleased changes to version `[0.2.0] - 2026-01-15`
26+
- Add proper release links
27+
- Document all new features and changes
28+
29+
### 3. Quality Assurance ✅
30+
- ✅ All tests pass (95 tests across 16 test files)
31+
- ✅ All packages build successfully
32+
- ✅ No linting errors
33+
34+
### 4. Git Tag Created ✅
35+
A git tag `v0.2.0` has been created locally with the release notes.
36+
37+
## What's New in v0.2.0
38+
39+
### Added
40+
- **Comprehensive test suite** using Vitest and React Testing Library
41+
- **Test coverage** for @object-ui/core, @object-ui/react, @object-ui/components, and @object-ui/designer packages
42+
- **GitHub Actions CI/CD workflows**:
43+
- CI workflow for automated testing, linting, and building
44+
- Release workflow for publishing new versions
45+
- **Test coverage reporting** with @vitest/coverage-v8
46+
- **Contributing guidelines** (CONTRIBUTING.md)
47+
- **Documentation** for testing and development workflow in README
48+
- **README files** for all core packages
49+
50+
### Changed
51+
- Updated package.json scripts to use Vitest instead of placeholder test commands
52+
- Enhanced README with testing instructions and CI status badges
53+
54+
## Next Steps to Complete the Release
55+
56+
### Option 1: Merge PR and Tag Manually (Recommended)
57+
58+
1. **Merge this PR** to the main branch
59+
60+
2. **After merging, checkout main and pull latest changes:**
61+
```bash
62+
git checkout main
63+
git pull origin main
64+
```
65+
66+
3. **Create and push the release tag:**
67+
```bash
68+
git tag -a v0.2.0 -m "Release version 0.2.0"
69+
git push origin v0.2.0
70+
```
71+
72+
4. **The GitHub Actions Release workflow will automatically:**
73+
- Run tests
74+
- Build all packages
75+
- Create a GitHub Release with the tag
76+
- (Optional) Publish to npm if you uncomment the publish steps in `.github/workflows/release.yml`
77+
78+
### Option 2: Tag from This Branch
79+
80+
1. **Checkout this branch:**
81+
```bash
82+
git checkout copilot/release-new-version
83+
```
84+
85+
2. **Push the tag that was created:**
86+
```bash
87+
git push origin v0.2.0
88+
```
89+
90+
3. **Then merge the PR to main**
91+
92+
Note: The tag `v0.2.0` already exists locally on this branch.
93+
94+
## Publishing to npm (Optional)
95+
96+
If you want to publish the packages to npm, you need to:
97+
98+
1. **Ensure you have an npm token** with publish permissions
99+
100+
2. **Add the token as a GitHub Secret** named `NPM_TOKEN`
101+
102+
3. **Uncomment the npm publish step** in `.github/workflows/release.yml`:
103+
```yaml
104+
- name: Publish to npm
105+
run: pnpm publish -r --access public
106+
env:
107+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
108+
```
109+
110+
4. **Ensure all packages have the correct npm settings** in their package.json:
111+
- `"publishConfig": { "access": "public" }` for scoped packages
112+
- Proper `main`, `module`, `types`, and `exports` fields
113+
114+
## Verification
115+
116+
After the release workflow completes, verify:
117+
118+
1. ✅ GitHub Release is created at: https://github.com/objectstack-ai/objectui/releases/tag/v0.2.0
119+
2. ✅ All packages are tagged correctly
120+
3. ✅ (If publishing) Packages are available on npm:
121+
- https://www.npmjs.com/package/@object-ui/types
122+
- https://www.npmjs.com/package/@object-ui/core
123+
- https://www.npmjs.com/package/@object-ui/react
124+
- https://www.npmjs.com/package/@object-ui/components
125+
- (and other packages)
126+
127+
## Rollback Plan
128+
129+
If something goes wrong:
130+
131+
1. **Delete the tag locally:**
132+
```bash
133+
git tag -d v0.2.0
134+
```
135+
136+
2. **Delete the tag remotely:**
137+
```bash
138+
git push origin :refs/tags/v0.2.0
139+
```
140+
141+
3. **Delete the GitHub Release** from the GitHub UI
142+
143+
4. **Fix the issues** and retry the release process
144+
145+
## Support
146+
147+
For questions or issues with this release:
148+
- Check the [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines
149+
- Review the [release workflow](.github/workflows/release.yml)
150+
- Open an issue on GitHub
151+
152+
---
153+
154+
**Release prepared by:** GitHub Copilot Workspace Agent
155+
**Date:** 2026-01-15

0 commit comments

Comments
 (0)