Skip to content

Commit d32c51f

Browse files
Updated Release-Readiness.md for post-alpha.2 state. (#76)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: mahyarmlk <mahyarmlk@users.noreply.github.com>
1 parent 10c47ae commit d32c51f

1 file changed

Lines changed: 21 additions & 23 deletions

File tree

docs/Release-Readiness.md

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22

33
## Status
44

5-
Intent's first public alpha has been published.
5+
Three public alpha releases have been published: `0.1.0-alpha.0`, `0.1.0-alpha.1`, and `0.1.0-alpha.2`.
66

7-
GitHub Release: [v0.1.0-alpha.0](https://github.com/intent-framework/intent/releases/tag/v0.1.0-alpha.0)
8-
9-
Four packages are published to npm under the `@intent-framework/*` scope. The server package `@intent-framework/server` remains private and unpublished.
7+
Five packages are under the `@intent-framework/*` scope, four of which are published to npm. The server package `@intent-framework/server` remains private and unpublished.
108

119
Changesets is installed and configured. Release workflows exist for automated version PRs and manual alpha publishing.
1210

@@ -31,7 +29,7 @@ Packages under `examples/` (e.g., `web-basic`) are private and must not be publi
3129

3230
| Field | Value | Status |
3331
|---|---|---|
34-
| Current version | `0.1.0` | Acceptable for alpha |
32+
| Current version | `0.1.0-alpha.1` | Acceptable for alpha |
3533
| `main` | `./dist/index.js` | Exists after build |
3634
| `module` | `./dist/index.js` | Exists after build |
3735
| `types` | `./dist/index.d.ts` | Exists after build |
@@ -49,7 +47,7 @@ Packages under `examples/` (e.g., `web-basic`) are private and must not be publi
4947

5048
| Field | Value | Status |
5149
|---|---|---|
52-
| Current version | `0.1.0` | Acceptable for alpha |
50+
| Current version | `0.1.0-alpha.2` | Acceptable for alpha |
5351
| `main` | `./dist/index.js` | Exists after build |
5452
| `module` | `./dist/index.js` | Exists after build |
5553
| `types` | `./dist/index.d.ts` | Exists after build |
@@ -65,7 +63,7 @@ Packages under `examples/` (e.g., `web-basic`) are private and must not be publi
6563

6664
| Field | Value | Status |
6765
|---|---|---|
68-
| Current version | `0.1.0` | Acceptable for alpha |
66+
| Current version | `0.1.0-alpha.1` | Acceptable for alpha |
6967
| `main` | `./dist/index.js` | Exists after build |
7068
| `module` | `./dist/index.js` | Exists after build |
7169
| `types` | `./dist/index.d.ts` | Exists after build |
@@ -81,7 +79,7 @@ Packages under `examples/` (e.g., `web-basic`) are private and must not be publi
8179

8280
| Field | Value | Status |
8381
|---|---|---|
84-
| Current version | `0.1.0` | Acceptable for alpha |
82+
| Current version | `0.1.0-alpha.1` | Acceptable for alpha |
8583
| `main` | `./dist/index.js` | Exists after build |
8684
| `module` | `./dist/index.js` | Exists after build |
8785
| `types` | `./dist/index.d.ts` | Exists after build |
@@ -97,7 +95,7 @@ Packages under `examples/` (e.g., `web-basic`) are private and must not be publi
9795

9896
| Field | Value | Status |
9997
|---|---|---|
100-
| Current version | `0.1.0` | Acceptable for alpha |
98+
| Current version | `0.1.0` | Acceptable for alpha (private) |
10199
| `main` | `./dist/index.js` | Exists after build |
102100
| `module` | `./dist/index.js` | Exists after build |
103101
| `types` | `./dist/index.d.ts` | Exists after build |
@@ -108,7 +106,7 @@ Packages under `examples/` (e.g., `web-basic`) are private and must not be publi
108106
| `repository` | Present | Points to `intent-framework/intent` (`packages/server`) |
109107
| `dependencies` | `@intent-framework/core` | Uses `workspace:*` |
110108
| Build tool | `tsdown` | Bundles ESM + `.d.ts` |
111-
| Publish? | No, private for first alpha | `"private": true` set; `publishConfig` removed |
109+
| Publish? | No, stays private | `"private": true` set; `publishConfig` removed |
112110
| Note | Early stage | Server package has global registries and basic action/resource/policy types. Not yet production-ready. |
113111

114112
## Package naming
@@ -121,7 +119,7 @@ The `intent-framework` npm organization has been created. The scope is:
121119
- `@intent-framework/dom`
122120
- `@intent-framework/router`
123121
- `@intent-framework/testing`
124-
- `@intent-framework/server` (private workspace package for first alpha)
122+
- `@intent-framework/server` (private workspace package, not published)
125123

126124
## Build outputs
127125

@@ -207,7 +205,7 @@ A [publish-alpha.yml](../.github/workflows/publish-alpha.yml) workflow exists fo
207205

208206
### Publish cadence
209207

210-
- Start with an **alpha release** (`0.1.0-alpha.0`)
208+
- Currently publishing **alpha releases** (`0.1.0-alpha.0` through `0.1.0-alpha.2` so far)
211209
- Use `Changesets` pre-release mode for alpha/beta
212210
- Graduate to stable after API surface is settled and real-world usage begins
213211

@@ -247,7 +245,7 @@ After a successful npm publish:
247245

248246
Do not manually create GitHub Releases.
249247

250-
## First alpha release checklist
248+
## Alpha release checklist
251249

252250
- [x] npm scope is `@intent-framework/*``intent-framework` org created, packages renamed
253251
- [x] MIT confirmed as intended public license
@@ -262,23 +260,23 @@ Do not manually create GitHub Releases.
262260
- Version Packages PR workflow (push-to-main)
263261
- Manual Publish Alpha workflow (manual dispatch only)
264262
- [x] NPM_TOKEN secret added to GitHub repository secrets
265-
- [x] Publish first alpha via manual Publish Alpha workflow
266-
- [x] GitHub Release v0.1.0-alpha.0 created
263+
- [x] First alpha published (v0.1.0-alpha.0)
264+
- [x] Subsequent alpha releases published (v0.1.0-alpha.1, v0.1.0-alpha.2)
267265

268266
## Post-release verification
269267

270-
Published packages:
268+
Published packages (latest alpha):
271269

272-
- `@intent-framework/core@0.1.0-alpha.0`
273-
- `@intent-framework/dom@0.1.0-alpha.0`
274-
- `@intent-framework/router@0.1.0-alpha.0`
275-
- `@intent-framework/testing@0.1.0-alpha.0`
270+
- `@intent-framework/core@0.1.0-alpha.1`
271+
- `@intent-framework/dom@0.1.0-alpha.2`
272+
- `@intent-framework/router@0.1.0-alpha.1`
273+
- `@intent-framework/testing@0.1.0-alpha.1`
276274

277275
Verified:
278276

279-
- npm install smoke test passed
280-
- `alpha` dist-tag points to `0.1.0-alpha.0`
281-
- `latest` dist-tag currently points to `0.1.0-alpha.0` because this is the only published version
277+
- npm install smoke test passed for alpha.0, alpha.1, alpha.2
278+
- `alpha` dist-tag points to the latest published alpha version
279+
- `latest` dist-tag points to the latest alpha because no stable releases exist yet
282280

283281
When stable releases exist, `latest` should point to stable releases and `alpha` should point to prereleases.
284282

0 commit comments

Comments
 (0)