|
2 | 2 |
|
3 | 3 | ## Status |
4 | 4 |
|
5 | | -Intent is in early experimental development. No packages have been published to npm. No GitHub Releases have been created. |
| 5 | +Intent's first public alpha has been published. |
6 | 6 |
|
7 | | -The repository has five workspace packages under `packages/*`. The four publishable packages are at version `0.1.0-alpha.0`. The private server package remains at `0.1.0`. All use `workspace:*` dependency references. The codebase is functional and validated by CI. Changesets is installed and configured. Release workflows exist for automated version PRs and manual alpha publishing. |
| 7 | +GitHub Release: [v0.1.0-alpha.0](https://github.com/intent-framework/intent/releases/tag/v0.1.0-alpha.0) |
8 | 8 |
|
9 | | -Four packages are intended for first-alpha publishing. `packages/server` is a private workspace package for now. |
| 9 | +Four packages are published to npm under the `@intent-framework/*` scope. The server package `@intent-framework/server` remains private and unpublished. |
10 | 10 |
|
11 | | -## Intended publishable packages |
| 11 | +Changesets is installed and configured. Release workflows exist for automated version PRs and manual alpha publishing. |
12 | 12 |
|
13 | | -The first alpha will publish four packages: |
| 13 | +## Published packages |
| 14 | + |
| 15 | +The following packages are published to npm: |
14 | 16 |
|
15 | 17 | | Package | npm name | Purpose | |
16 | 18 | |---|---|---| |
@@ -243,48 +245,36 @@ Do not manually create GitHub Releases. |
243 | 245 | - [x] Release workflows added: |
244 | 246 | - Version Packages PR workflow (push-to-main) |
245 | 247 | - Manual Publish Alpha workflow (manual dispatch only) |
246 | | -- [ ] NPM_TOKEN secret added to GitHub repository secrets |
247 | | -- [ ] Publish first alpha via manual Publish Alpha workflow |
248 | | -- [ ] Optionally create a GitHub Release manually after npm publish |
249 | | - |
250 | | -## Current blockers |
251 | | - |
252 | | -- repository fields: present |
253 | | -- GitHub repository home: `intent-framework/intent` |
254 | | -- Changesets: installed and configured |
255 | | -- Release workflows: version-packages.yml (automated version PRs) and publish-alpha.yml (manual publish) are added |
256 | | -- Remaining first-alpha blocker: add `NPM_TOKEN` secret, then manually run Publish Alpha |
| 248 | +- [x] NPM_TOKEN secret added to GitHub repository secrets |
| 249 | +- [x] Publish first alpha via manual Publish Alpha workflow |
| 250 | +- [x] GitHub Release v0.1.0-alpha.0 created |
257 | 251 |
|
258 | | -## Future server-package decisions |
| 252 | +## Post-release verification |
259 | 253 |
|
260 | | -- Server maturity is no longer a first-alpha publishing blocker because server is private |
261 | | -- When the server API matures, the package can be made public and published as a separate decision |
| 254 | +Published packages: |
262 | 255 |
|
263 | | -## Do not do yet |
| 256 | +- `@intent-framework/core@0.1.0-alpha.0` |
| 257 | +- `@intent-framework/dom@0.1.0-alpha.0` |
| 258 | +- `@intent-framework/router@0.1.0-alpha.0` |
| 259 | +- `@intent-framework/testing@0.1.0-alpha.0` |
264 | 260 |
|
265 | | -- Do not publish any package to npm until the manual Publish Alpha workflow is triggered. |
266 | | -- Do not create a GitHub Release yet. The current manual Publish Alpha workflow publishes npm packages only. GitHub Releases are not automated yet. |
267 | | -- Do not change runtime or public APIs. |
268 | | -- Do not add new dependencies unless required for a specific task. |
| 261 | +Verified: |
269 | 262 |
|
270 | | -## Required secret: NPM_TOKEN |
| 263 | +- npm install smoke test passed |
| 264 | +- `alpha` dist-tag points to `0.1.0-alpha.0` |
| 265 | +- `latest` dist-tag currently points to `0.1.0-alpha.0` because this is the only published version |
271 | 266 |
|
272 | | -Before running the Publish Alpha workflow, a GitHub Actions secret must be added: |
| 267 | +When stable releases exist, `latest` should point to stable releases and `alpha` should point to prereleases. |
273 | 268 |
|
274 | | -| Secret | Purpose | |
275 | | -|---|---| |
276 | | -| `NPM_TOKEN` | npm access token with publish permission for `@intent-framework/*` packages | |
| 269 | +## Server package |
277 | 270 |
|
278 | | -The token must: |
279 | | -- Have **publish** permission for the `@intent-framework` npm organization |
280 | | -- Be stored as a GitHub Actions secret (not in the repository) |
281 | | -- Be configured in the `npm` GitHub environment used by the Publish Alpha workflow |
| 271 | +`@intent-framework/server` remains a private workspace package until the server API matures. When the server API matures, the package can be made public and published as a separate decision. |
282 | 272 |
|
283 | | -Do not commit the token value to the repository. |
| 273 | +## NPM_TOKEN |
284 | 274 |
|
285 | | -### Future improvement: trusted publishing |
| 275 | +`NPM_TOKEN` is required for manual publishing. Prefer environment-scoped GitHub secret under the `npm` environment. Use least privilege. |
286 | 276 |
|
287 | | -Migrate npm publishing to trusted publishing / OIDC once the initial package publishing flow is stable. |
| 277 | +Future improvement: migrate npm publishing to trusted publishing / OIDC once the initial package publishing flow is stable. |
288 | 278 |
|
289 | 279 | ## Pack check command |
290 | 280 |
|
|
0 commit comments