Skip to content

Commit 466a94f

Browse files
author
guanjiawei
committed
docs: add release and packaging guidance
1 parent 5974f4a commit 466a94f

3 files changed

Lines changed: 143 additions & 0 deletions

File tree

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ This repository contains the OpenClaw-facing parts of AIMA Doctor only:
1010
- `scripts/build-release.sh`: reproducible release packager
1111
- `dist/<version>/`: generated release artifacts
1212

13+
The AIMA platform backend, `/doctor/*.zip` distribution endpoints, invite-code
14+
policy, and end-to-end platform tests remain in the main
15+
`Approaching-AI/aima-service-new` repository. This repo is the public
16+
OpenClaw-facing package source.
17+
1318
## Supported flow
1419

1520
`/aima` is a deterministic rescue entrypoint for OpenClaw when the normal agent path is degraded but the gateway is still alive and able to receive messages.
@@ -34,6 +39,17 @@ That command generates:
3439
- `dist/1.2.1/PUBLISH.md`
3540
- `dist/1.2.1/SHA256SUMS.txt`
3641

42+
## Versioning
43+
44+
This repo intentionally tracks two version surfaces:
45+
46+
- Git tags such as `v0.1`: public repo milestones
47+
- Bundle version in `VERSION` such as `1.2.1`: the packaged AIMA Doctor bundle
48+
version used by the plugin, runtime, and ClawHub skill
49+
50+
That means the GitHub release can be `v0.1` while the shipped OpenClaw package
51+
version is still `1.2.1`.
52+
3753
## Install the native plugin
3854

3955
```bash
@@ -48,6 +64,8 @@ cd dist/1.2.1/clawhub-skill
4864
clawhub publish ./aima-doctor --slug aima-doctor --name "AIMA Doctor" --version 1.2.1
4965
```
5066

67+
For a full release checklist, see `docs/releasing.md`.
68+
5169
## Runtime defaults
5270

5371
- Homepage: `https://aimaservice.ai/doctor`

docs/releases/v0.1.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# aima-openclaw v0.1
2+
3+
Initial public release of the standalone OpenClaw-facing AIMA Doctor package.
4+
5+
## Included bundle version
6+
7+
- AIMA Doctor bundle version: `1.2.1`
8+
9+
## Included artifacts
10+
11+
- `aima-doctor-plugin.zip`
12+
- `aima-doctor-runtime.zip`
13+
- `aima-doctor-skill.zip`
14+
- `SHA256SUMS.txt`
15+
- `PUBLISH.md`
16+
17+
## Scope
18+
19+
- Native OpenClaw gateway plugin for `/aima`
20+
- Standalone runtime helper for macOS, Linux, and Windows
21+
- ClawHub-publishable compatibility skill bundle
22+
- Public release packaging flow separated from the main AIMA platform repo
23+
24+
## Notes
25+
26+
- Git tag `v0.1` marks the public repo milestone.
27+
- Bundle version `1.2.1` is the packaged OpenClaw artifact version.
28+
- ClawHub publishing should use `dist/1.2.1/clawhub-skill/aima-doctor/`.

docs/releasing.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# Releasing `aima-openclaw`
2+
3+
This repo ships OpenClaw-facing artifacts only. A normal public release should
4+
produce and publish three bundles:
5+
6+
- `aima-doctor-plugin.zip`
7+
- `aima-doctor-runtime.zip`
8+
- `aima-doctor-skill.zip`
9+
10+
## 1. Update the bundle version
11+
12+
Edit `VERSION` when the packaged AIMA Doctor bundle changes.
13+
14+
Current value:
15+
16+
```text
17+
1.2.1
18+
```
19+
20+
The `VERSION` file controls:
21+
22+
- generated `dist/<version>/`
23+
- `PUBLISH.md`
24+
- ClawHub publish examples
25+
26+
## 2. Build release artifacts
27+
28+
```bash
29+
bash scripts/build-release.sh
30+
```
31+
32+
Verify these outputs exist:
33+
34+
- `dist/<version>/aima-doctor-plugin.zip`
35+
- `dist/<version>/aima-doctor-runtime.zip`
36+
- `dist/<version>/aima-doctor-skill.zip`
37+
- `dist/<version>/SHA256SUMS.txt`
38+
- `dist/<version>/PUBLISH.md`
39+
40+
## 3. Commit and push
41+
42+
```bash
43+
git add .
44+
git commit -m "release: prepare <version>"
45+
git push origin main
46+
```
47+
48+
## 4. Create a Git tag
49+
50+
Repo tags mark public milestones and do not have to match the bundle version.
51+
52+
Example:
53+
54+
```bash
55+
git tag v0.1
56+
git push origin v0.1
57+
```
58+
59+
## 5. Create the GitHub Release
60+
61+
Attach the generated bundles:
62+
63+
```bash
64+
gh release create v0.1 \
65+
dist/<version>/aima-doctor-plugin.zip \
66+
dist/<version>/aima-doctor-runtime.zip \
67+
dist/<version>/aima-doctor-skill.zip \
68+
dist/<version>/SHA256SUMS.txt \
69+
dist/<version>/PUBLISH.md
70+
```
71+
72+
Recommended release note shape:
73+
74+
- public milestone tag, for example `v0.1`
75+
- packaged bundle version, for example `1.2.1`
76+
- attached plugin/runtime/skill bundle list
77+
- note that ClawHub publish should use the unpacked `dist/<version>/clawhub-skill/aima-doctor/`
78+
79+
## 6. Publish to ClawHub
80+
81+
Use the rendered skill directory, not the zip file:
82+
83+
```bash
84+
cd dist/<version>/clawhub-skill
85+
clawhub publish ./aima-doctor --slug aima-doctor --name "AIMA Doctor" --version <version>
86+
```
87+
88+
## Repo boundary
89+
90+
Keep these concerns out of this repo:
91+
92+
- AIMA platform backend code
93+
- `/doctor/plugin.zip`, `/doctor/runtime.zip`, `/doctor/skill.zip` HTTP routes
94+
- invite-code seeding and platform config
95+
- platform integration tests
96+
97+
Those stay in `Approaching-AI/aima-service-new`.

0 commit comments

Comments
 (0)