Skip to content

Commit eeebc14

Browse files
authored
Merge pull request #9 from autonomys/docs/readme-updates
docs: Add publish workflow and ClawHub install details to README
2 parents 86bae9e + 05bf4f9 commit eeebc14

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,12 @@ Each skill lives in its own directory under `autonomys/` with a `SKILL.md` that
1717

1818
### auto-memory
1919

20+
[clawhub.ai/jim-counter/auto-memory](https://clawhub.ai/jim-counter/auto-memory)
21+
22+
```bash
23+
npx clawhub install auto-memory
24+
```
25+
2026
Permanent decentralized storage via the Autonomys Auto Drive API. Gives your agent:
2127

2228
- **Permanent file storage** — upload any file to the Autonomys Network and get back a CID. The data is distributed across the network and never expires.
@@ -27,6 +33,12 @@ auto-memory only needs an Auto Drive API key (free at [ai3.storage](https://ai3.
2733

2834
### auto-respawn
2935

36+
[clawhub.ai/jim-counter/auto-respawn](https://clawhub.ai/jim-counter/auto-respawn)
37+
38+
```bash
39+
npx clawhub install auto-respawn
40+
```
41+
3042
On-chain identity and memory anchoring on the Autonomys Network. Gives your agent:
3143

3244
- **Permanent identity** — a wallet with two addresses (consensus `su...` and EVM `0x...`) derived from a single recovery phrase. This is the agent's verifiable on-chain identity.
@@ -38,3 +50,48 @@ auto-respawn **requires auto-memory** (or equivalent) to have something worth an
3850
### auto-drive (deprecated)
3951

4052
The original name for the auto-memory skill. Preserved for backward compatibility but no longer maintained. Use `autonomys/auto-memory/` instead.
53+
54+
## CI
55+
56+
GitHub Actions runs on PRs and pushes to `main` (`.github/workflows/ci.yml`):
57+
58+
- **TypeScript** — type check (`tsc --noEmit`), lint (`eslint .`), and test (`vitest run`) for auto-respawn (Node 22)
59+
- **Shell**`shellcheck -x -S warning` on all auto-memory scripts (except `_lib.sh`, which is validated in context via `-x`)
60+
61+
## Publishing
62+
63+
Skills are published to [ClawHub](https://docs.openclaw.ai) via `.github/workflows/publish.yml`. The workflow triggers on tags matching `*/v*`.
64+
65+
### How to publish a release
66+
67+
1. **Tag the commit** using the pattern `<skill>/v<semver>`:
68+
69+
```bash
70+
git tag auto-memory/v0.2.0
71+
git tag auto-respawn/v0.1.0-beta.3
72+
```
73+
74+
2. **Push the tag:**
75+
76+
```bash
77+
git push origin auto-memory/v0.2.0
78+
```
79+
80+
3. The workflow automatically:
81+
- Parses the skill name and version from the tag (strips the `v` prefix — ClawHub expects bare semver like `0.2.0`, not `v0.2.0`)
82+
- Resolves the skill directory (`autonomys/auto-memory` or `autonomys/auto-respawn`)
83+
- Validates that `SKILL.md` exists in the directory
84+
- Authenticates with ClawHub using the `CLAWHUB_TOKEN` repository secret
85+
- Publishes with `npx clawhub publish` including `--tags beta`
86+
87+
### Supported skills
88+
89+
| Tag prefix | Directory | ClawHub slug | Display name |
90+
|---|---|---|---|
91+
| `auto-memory/v*` | `autonomys/auto-memory` | `auto-memory` | Auto Memory |
92+
| `auto-respawn/v*` | `autonomys/auto-respawn` | `auto-respawn` | Auto Respawn |
93+
94+
### Requirements
95+
96+
- A `CLAWHUB_TOKEN` repository secret must be configured in GitHub
97+
- The tagged commit must contain a valid `SKILL.md` in the skill's directory

0 commit comments

Comments
 (0)