@propxchain/core-client 0.1.0-canary.3 → 0.1.0-canary.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -105,11 +105,33 @@ Error codes: `NETWORK`, `CANISTER_REJECT`, `UNAUTHENTICATED`, `TIMEOUT`, `INVALI
|
|
|
105
105
|
|
|
106
106
|
Two tags on npm:
|
|
107
107
|
|
|
108
|
-
- **`latest`** — stable. `npm install @propxchain/core-client`.
|
|
109
|
-
- **`canary`** — pre-release cut on every push to `main` that touches `packages/core-client/`. `npm install @propxchain/core-client@canary`. Version format: `X.Y.Z-canary.N` where `N` is the GitHub Actions run number.
|
|
108
|
+
- **`latest`** — stable. `npm install @propxchain/core-client`. Cut manually via the `core-client release (stable)` GitHub Actions workflow.
|
|
109
|
+
- **`canary`** — pre-release cut automatically on every push to `main` that touches `packages/core-client/`. `npm install @propxchain/core-client@canary`. Version format: `X.Y.Z-canary.N` where `N` is the GitHub Actions run number.
|
|
110
110
|
|
|
111
111
|
Canary is for smoke-testing consumer integrations before a stable cut. Do not pin production deployments to `canary`.
|
|
112
112
|
|
|
113
|
+
### Cutting a stable release
|
|
114
|
+
|
|
115
|
+
From a clean main branch:
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
pnpm changeset # describe the change + pick bump level
|
|
119
|
+
git add .changeset/*.md && git commit -m "chore: changeset for v0.x.y" && git push
|
|
120
|
+
|
|
121
|
+
pnpm changeset version # bumps package.json + writes CHANGELOG
|
|
122
|
+
git add -A && git commit -m "chore: release core-client v0.x.y" && git push
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
Then trigger the release in GitHub:
|
|
126
|
+
|
|
127
|
+
```bash
|
|
128
|
+
gh workflow run core-client-release.yml
|
|
129
|
+
# or with dry-run to preview:
|
|
130
|
+
gh workflow run core-client-release.yml -f dry-run=true
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
The workflow validates the version has no pre-release suffix, confirms it isn't already on npm, publishes with `--tag latest`, and creates a `core-client@X.Y.Z` git tag.
|
|
134
|
+
|
|
113
135
|
## License
|
|
114
136
|
|
|
115
137
|
UNLICENSED — internal use only until public launch.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@propxchain/core-client",
|
|
3
|
-
"version": "0.1.0-canary.
|
|
3
|
+
"version": "0.1.0-canary.4",
|
|
4
4
|
"description": "Typed TypeScript client for the PropXchain core canisters on the Internet Computer. Includes a deterministic mock mode for local development and tests.",
|
|
5
5
|
"license": "UNLICENSED",
|
|
6
6
|
"type": "module",
|