@lssm/example.lifecycle-dashboard 0.0.0-canary-20251217063201 → 0.0.0-canary-20251217073102
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/.turbo/turbo-build$colon$bundle.log +36 -36
- package/CHANGELOG.md +3 -2
- package/dist/docs/index.js +1 -1
- package/dist/docs/lifecycle-dashboard.docblock.js +19 -7
- package/dist/example.js +35 -1
- package/dist/index.js +5 -1
- package/dist/libs/contracts/dist/docs/PUBLISHING.docblock.js +16 -76
- package/dist/libs/contracts/dist/docs/accessibility_wcag_compliance_specs.docblock.js +16 -350
- package/dist/libs/contracts/dist/docs/index.js +29 -1
- package/dist/libs/contracts/dist/docs/presentations.js +71 -1
- package/dist/libs/contracts/dist/docs/registry.js +44 -1
- package/dist/libs/contracts/dist/docs/tech/PHASE_1_QUICKSTART.docblock.js +16 -383
- package/dist/libs/contracts/dist/docs/tech/PHASE_2_AI_NATIVE_OPERATIONS.docblock.js +16 -68
- package/dist/libs/contracts/dist/docs/tech/PHASE_3_AUTO_EVOLUTION.docblock.js +16 -140
- package/dist/libs/contracts/dist/docs/tech/PHASE_4_PERSONALIZATION_ENGINE.docblock.js +16 -86
- package/dist/libs/contracts/dist/docs/tech/PHASE_5_ZERO_TOUCH_OPERATIONS.docblock.js +16 -1
- package/dist/libs/contracts/dist/docs/tech/auth/better-auth-nextjs.docblock.js +24 -2
- package/dist/libs/contracts/dist/docs/tech/contracts/openapi-export.docblock.js +21 -2
- package/dist/libs/contracts/dist/docs/tech/lifecycle-stage-system.docblock.js +16 -213
- package/dist/libs/contracts/dist/docs/tech/llm/llm-integration.docblock.js +73 -5
- package/dist/libs/contracts/dist/docs/tech/mcp-endpoints.docblock.js +37 -1
- package/dist/libs/contracts/dist/docs/tech/presentation-runtime.docblock.js +16 -1
- package/dist/libs/contracts/dist/docs/tech/schema/README.docblock.js +20 -262
- package/dist/libs/contracts/dist/docs/tech/studio/learning-events.docblock.js +48 -1
- package/dist/libs/contracts/dist/docs/tech/studio/learning-journeys.docblock.js +24 -2
- package/dist/libs/contracts/dist/docs/tech/studio/platform-admin-panel.docblock.js +23 -2
- package/dist/libs/contracts/dist/docs/tech/studio/project-access-teams.docblock.js +25 -16
- package/dist/libs/contracts/dist/docs/tech/studio/project-routing.docblock.js +67 -1
- package/dist/libs/contracts/dist/docs/tech/studio/sandbox-unlogged.docblock.js +22 -2
- package/dist/libs/contracts/dist/docs/tech/studio/team-invitations.docblock.js +40 -36
- package/dist/libs/contracts/dist/docs/tech/studio/workspace-ops.docblock.js +47 -1
- package/dist/libs/contracts/dist/docs/tech/studio/workspaces.docblock.js +23 -2
- package/dist/libs/contracts/dist/docs/tech/telemetry-ingest.docblock.js +36 -3
- package/dist/libs/contracts/dist/docs/tech/templates/runtime.docblock.js +20 -1
- package/dist/libs/contracts/dist/docs/tech/vscode-extension.docblock.js +36 -3
- package/dist/libs/contracts/dist/docs/tech/workflows/overview.docblock.js +20 -1
- package/dist/snippets/page.js +12 -2
- package/package.json +5 -4
|
@@ -7,45 +7,45 @@
|
|
|
7
7
|
[34mℹ[39m tsconfig: [34mtsconfig.json[39m
|
|
8
8
|
[34mℹ[39m Build start
|
|
9
9
|
[34mℹ[39m Cleaning 54 files
|
|
10
|
-
[34mℹ[39m [2mdist/[22m[1msnippets/page.js[22m [2m 1.
|
|
11
|
-
[34mℹ[39m [2mdist/[22m[1mdocs/lifecycle-dashboard.docblock.js[22m [2m 0.
|
|
12
|
-
[34mℹ[39m [2mdist/[22m[1mexample.js[22m [2m 0.
|
|
13
|
-
[34mℹ[39m [2mdist/[22m[1mindex.js[22m [2m 0.
|
|
10
|
+
[34mℹ[39m [2mdist/[22m[1msnippets/page.js[22m [2m 1.79 kB[22m [2m│ gzip: 0.85 kB[22m
|
|
11
|
+
[34mℹ[39m [2mdist/[22m[1mdocs/lifecycle-dashboard.docblock.js[22m [2m 0.98 kB[22m [2m│ gzip: 0.55 kB[22m
|
|
12
|
+
[34mℹ[39m [2mdist/[22m[1mexample.js[22m [2m 0.76 kB[22m [2m│ gzip: 0.42 kB[22m
|
|
13
|
+
[34mℹ[39m [2mdist/[22m[1mindex.js[22m [2m 0.22 kB[22m [2m│ gzip: 0.14 kB[22m
|
|
14
14
|
[34mℹ[39m [2mdist/[22m[1mdocs/index.js[22m [2m 0.04 kB[22m [2m│ gzip: 0.06 kB[22m
|
|
15
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/accessibility_wcag_compliance_specs.docblock.js [2m16.
|
|
16
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/schema/README.docblock.js [
|
|
17
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/lifecycle-stage-system.docblock.js [2m 9.
|
|
18
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/llm/llm-integration.docblock.js [2m 9.
|
|
19
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/PHASE_1_QUICKSTART.docblock.js [2m
|
|
20
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/PHASE_3_AUTO_EVOLUTION.docblock.js [2m
|
|
21
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/templates/runtime.docblock.js [2m 5.
|
|
22
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/workflows/overview.docblock.js [2m 5.
|
|
23
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/PHASE_5_ZERO_TOUCH_OPERATIONS.docblock.js [2m 4.
|
|
24
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/telemetry-ingest.docblock.js [2m
|
|
25
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/vscode-extension.docblock.js [2m 3.
|
|
26
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/PUBLISHING.docblock.js [2m 3.
|
|
27
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/auth/better-auth-nextjs.docblock.js [2m 3.
|
|
28
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/studio/learning-journeys.docblock.js [2m 3.
|
|
29
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/studio/platform-admin-panel.docblock.js [2m 3.
|
|
30
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/PHASE_2_AI_NATIVE_OPERATIONS.docblock.js [2m
|
|
31
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/PHASE_4_PERSONALIZATION_ENGINE.docblock.js [2m
|
|
32
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/presentation-runtime.docblock.js [2m 2.
|
|
33
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/studio/project-routing.docblock.js [2m 2.
|
|
34
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/studio/team-invitations.docblock.js [2m 2.
|
|
35
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/
|
|
36
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/studio/
|
|
37
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/
|
|
38
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/
|
|
39
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/studio/
|
|
40
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/
|
|
41
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/
|
|
42
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/
|
|
43
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/
|
|
44
|
-
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/
|
|
15
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/accessibility_wcag_compliance_specs.docblock.js [2m16.91 kB[22m [2m│ gzip: 7.23 kB[22m
|
|
16
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/schema/README.docblock.js [2m11.21 kB[22m [2m│ gzip: 4.33 kB[22m
|
|
17
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/lifecycle-stage-system.docblock.js [2m 9.96 kB[22m [2m│ gzip: 3.83 kB[22m
|
|
18
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/llm/llm-integration.docblock.js [2m 9.53 kB[22m [2m│ gzip: 3.50 kB[22m
|
|
19
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/PHASE_1_QUICKSTART.docblock.js [2m 9.22 kB[22m [2m│ gzip: 2.77 kB[22m
|
|
20
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/PHASE_3_AUTO_EVOLUTION.docblock.js [2m 6.16 kB[22m [2m│ gzip: 2.65 kB[22m
|
|
21
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/templates/runtime.docblock.js [2m 5.85 kB[22m [2m│ gzip: 2.66 kB[22m
|
|
22
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/workflows/overview.docblock.js [2m 5.66 kB[22m [2m│ gzip: 2.34 kB[22m
|
|
23
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/PHASE_5_ZERO_TOUCH_OPERATIONS.docblock.js [2m 4.62 kB[22m [2m│ gzip: 2.13 kB[22m
|
|
24
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/telemetry-ingest.docblock.js [2m 4.16 kB[22m [2m│ gzip: 1.78 kB[22m
|
|
25
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/vscode-extension.docblock.js [2m 3.85 kB[22m [2m│ gzip: 1.47 kB[22m
|
|
26
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/PUBLISHING.docblock.js [2m 3.62 kB[22m [2m│ gzip: 1.65 kB[22m
|
|
27
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/auth/better-auth-nextjs.docblock.js [2m 3.60 kB[22m [2m│ gzip: 1.53 kB[22m
|
|
28
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/studio/learning-journeys.docblock.js [2m 3.33 kB[22m [2m│ gzip: 1.47 kB[22m
|
|
29
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/studio/platform-admin-panel.docblock.js [2m 3.30 kB[22m [2m│ gzip: 1.42 kB[22m
|
|
30
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/PHASE_2_AI_NATIVE_OPERATIONS.docblock.js [2m 3.25 kB[22m [2m│ gzip: 1.59 kB[22m
|
|
31
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/PHASE_4_PERSONALIZATION_ENGINE.docblock.js [2m 3.13 kB[22m [2m│ gzip: 1.47 kB[22m
|
|
32
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/presentation-runtime.docblock.js [2m 2.97 kB[22m [2m│ gzip: 1.38 kB[22m
|
|
33
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/studio/project-routing.docblock.js [2m 2.75 kB[22m [2m│ gzip: 1.22 kB[22m
|
|
34
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/studio/team-invitations.docblock.js [2m 2.40 kB[22m [2m│ gzip: 1.13 kB[22m
|
|
35
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/presentations.js [2m 2.18 kB[22m [2m│ gzip: 0.77 kB[22m
|
|
36
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/studio/workspaces.docblock.js [2m 2.13 kB[22m [2m│ gzip: 1.02 kB[22m
|
|
37
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/studio/learning-events.docblock.js [2m 2.04 kB[22m [2m│ gzip: 0.97 kB[22m
|
|
38
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/contracts/openapi-export.docblock.js [2m 1.96 kB[22m [2m│ gzip: 0.97 kB[22m
|
|
39
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/studio/project-access-teams.docblock.js [2m 1.85 kB[22m [2m│ gzip: 0.87 kB[22m
|
|
40
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/studio/workspace-ops.docblock.js [2m 1.73 kB[22m [2m│ gzip: 0.82 kB[22m
|
|
41
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/index.js [2m 1.58 kB[22m [2m│ gzip: 0.51 kB[22m
|
|
42
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/mcp-endpoints.docblock.js [2m 1.46 kB[22m [2m│ gzip: 0.77 kB[22m
|
|
43
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/registry.js [2m 1.25 kB[22m [2m│ gzip: 0.56 kB[22m
|
|
44
|
+
[34mℹ[39m [2mdist/[22mlibs/contracts/dist/docs/tech/studio/sandbox-unlogged.docblock.js [2m 1.14 kB[22m [2m│ gzip: 0.65 kB[22m
|
|
45
45
|
[34mℹ[39m [2mdist/[22m[32m[1msnippets/page.d.ts[22m[39m [2m 1.85 kB[22m [2m│ gzip: 0.86 kB[22m
|
|
46
46
|
[34mℹ[39m [2mdist/[22m[32m[1mexample.d.ts[22m[39m [2m 0.99 kB[22m [2m│ gzip: 0.42 kB[22m
|
|
47
47
|
[34mℹ[39m [2mdist/[22m[32m[1mindex.d.ts[22m[39m [2m 0.16 kB[22m [2m│ gzip: 0.11 kB[22m
|
|
48
48
|
[34mℹ[39m [2mdist/[22m[32m[1mdocs/index.d.ts[22m[39m [2m 0.01 kB[22m [2m│ gzip: 0.03 kB[22m
|
|
49
49
|
[34mℹ[39m [2mdist/[22m[32m[1mdocs/lifecycle-dashboard.docblock.d.ts[22m[39m [2m 0.01 kB[22m [2m│ gzip: 0.03 kB[22m
|
|
50
|
-
[34mℹ[39m 40 files, total:
|
|
51
|
-
[32m✔[39m Build complete in [
|
|
50
|
+
[34mℹ[39m 40 files, total: 139.61 kB
|
|
51
|
+
[32m✔[39m Build complete in [32m1299ms[39m
|
package/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @lssm/example.lifecycle-dashboard
|
|
2
2
|
|
|
3
|
-
## 0.0.0-canary-
|
|
3
|
+
## 0.0.0-canary-20251217073102
|
|
4
4
|
|
|
5
5
|
### Minor Changes
|
|
6
6
|
|
|
@@ -9,4 +9,5 @@
|
|
|
9
9
|
### Patch Changes
|
|
10
10
|
|
|
11
11
|
- Updated dependencies [66a5dfd]
|
|
12
|
-
- @lssm/lib.contracts@0.0.0-canary-
|
|
12
|
+
- @lssm/lib.contracts@0.0.0-canary-20251217073102
|
|
13
|
+
- @lssm/lib.schema@0.0.0-canary-20251217073102
|
package/dist/docs/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import"./lifecycle-dashboard.docblock.js";
|
|
1
|
+
import "./lifecycle-dashboard.docblock.js";
|
|
@@ -1,8 +1,20 @@
|
|
|
1
|
-
import{
|
|
2
|
-
|
|
3
|
-
- A card-shaped UI pattern for stage + confidence + recommendations.
|
|
1
|
+
import { registerDocBlocks } from "../libs/contracts/dist/docs/registry.js";
|
|
2
|
+
import "../libs/contracts/dist/docs/index.js";
|
|
4
3
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
4
|
+
//#region src/docs/lifecycle-dashboard.docblock.ts
|
|
5
|
+
registerDocBlocks([{
|
|
6
|
+
id: "docs.examples.lifecycle-dashboard",
|
|
7
|
+
title: "Lifecycle Dashboard (example snippet)",
|
|
8
|
+
summary: "Minimal dashboard page pattern that calls lifecycle-managed API routes and renders a status card.",
|
|
9
|
+
kind: "reference",
|
|
10
|
+
visibility: "public",
|
|
11
|
+
route: "/docs/examples/lifecycle-dashboard",
|
|
12
|
+
tags: [
|
|
13
|
+
"lifecycle",
|
|
14
|
+
"dashboard",
|
|
15
|
+
"example"
|
|
16
|
+
],
|
|
17
|
+
body: `## What this example shows\n- A simple client-driven fetch to \`POST /api/lifecycle/assessments\`.\n- A card-shaped UI pattern for stage + confidence + recommendations.\n\n## Notes\n- Keep your app design-system-first (no raw HTML in application code).\n- Add explicit loading/error/empty states with accessible messaging.\n- Implement API routes in your app as thin adapters over lifecycle-managed services.`
|
|
18
|
+
}]);
|
|
19
|
+
|
|
20
|
+
//#endregion
|
package/dist/example.js
CHANGED
|
@@ -1 +1,35 @@
|
|
|
1
|
-
|
|
1
|
+
//#region src/example.ts
|
|
2
|
+
const example = {
|
|
3
|
+
id: "lifecycle-dashboard",
|
|
4
|
+
title: "Lifecycle Dashboard (snippet)",
|
|
5
|
+
summary: "A minimal dashboard page pattern: call lifecycle-managed endpoints and render a mobile-friendly status card.",
|
|
6
|
+
tags: [
|
|
7
|
+
"lifecycle",
|
|
8
|
+
"dashboard",
|
|
9
|
+
"nextjs",
|
|
10
|
+
"snippet"
|
|
11
|
+
],
|
|
12
|
+
kind: "blueprint",
|
|
13
|
+
visibility: "public",
|
|
14
|
+
docs: { rootDocId: "docs.examples.lifecycle-dashboard" },
|
|
15
|
+
entrypoints: {
|
|
16
|
+
packageName: "@lssm/example.lifecycle-dashboard",
|
|
17
|
+
docs: "./docs"
|
|
18
|
+
},
|
|
19
|
+
surfaces: {
|
|
20
|
+
templates: true,
|
|
21
|
+
sandbox: {
|
|
22
|
+
enabled: true,
|
|
23
|
+
modes: ["markdown", "specs"]
|
|
24
|
+
},
|
|
25
|
+
studio: {
|
|
26
|
+
enabled: true,
|
|
27
|
+
installable: true
|
|
28
|
+
},
|
|
29
|
+
mcp: { enabled: true }
|
|
30
|
+
}
|
|
31
|
+
};
|
|
32
|
+
var example_default = example;
|
|
33
|
+
|
|
34
|
+
//#endregion
|
|
35
|
+
export { example_default as default };
|
package/dist/index.js
CHANGED
|
@@ -1 +1,5 @@
|
|
|
1
|
-
import
|
|
1
|
+
import example_default from "./example.js";
|
|
2
|
+
import { lifecycleDashboardNextPageSnippet } from "./snippets/page.js";
|
|
3
|
+
import "./docs/index.js";
|
|
4
|
+
|
|
5
|
+
export { example_default as example, lifecycleDashboardNextPageSnippet };
|
|
@@ -1,76 +1,16 @@
|
|
|
1
|
-
import{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
## Prerequisites
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
## Canary Workflow (Automatic)
|
|
19
|
-
|
|
20
|
-
Every commit pushed to \`main\` triggers the \`.github/workflows/publish-canary.yml\` workflow.
|
|
21
|
-
|
|
22
|
-
1. **Trigger**: Push to \`main\`.
|
|
23
|
-
2. **Versioning**: Runs \`changeset version --snapshot canary\` to generate a temporary snapshot version.
|
|
24
|
-
3. **Publish**: Packages are published to npm with the \`canary\` tag using \`changeset publish --tag canary\`.
|
|
25
|
-
|
|
26
|
-
### Consuming Canary Builds
|
|
27
|
-
|
|
28
|
-
To install the latest bleeding-edge version:
|
|
29
|
-
|
|
30
|
-
\`\`\`bash
|
|
31
|
-
npm install @lssm/lib.contracts@canary
|
|
32
|
-
# or
|
|
33
|
-
bun add @lssm/lib.contracts@canary
|
|
34
|
-
\`\`\`
|
|
35
|
-
|
|
36
|
-
## Stable Release Workflow (Manual)
|
|
37
|
-
|
|
38
|
-
Stable releases are managed via the \`release\` branch using the standard [Changesets Action](https://github.com/changesets/action).
|
|
39
|
-
|
|
40
|
-
1. **Develop on \`main\`**: Create features and fixes.
|
|
41
|
-
2. **Add Changesets**: Run \`bun changeset\` to document changes and impact (major/minor/patch).
|
|
42
|
-
3. **Merge to \`release\`**: When ready to ship, open a PR from \`main\` to \`release\` or merge manually.
|
|
43
|
-
4. **"Version Packages" PR**:
|
|
44
|
-
- The GitHub Action detects new changesets and automatically creates a Pull Request titled **"Version Packages"**.
|
|
45
|
-
- This PR contains the version bumps and updated \`CHANGELOG.md\` files.
|
|
46
|
-
5. **Merge & Publish**:
|
|
47
|
-
- Review and merge the "Version Packages" PR.
|
|
48
|
-
- The Action runs again, detects the versions have been bumped, builds the libraries, and publishes them to npm with the \`latest\` tag.
|
|
49
|
-
|
|
50
|
-
### Publishing Steps
|
|
51
|
-
|
|
52
|
-
1. Ensure all changesets are present on \`main\`.
|
|
53
|
-
2. Merge \`main\` into \`release\`:
|
|
54
|
-
\`\`\`bash
|
|
55
|
-
git checkout release
|
|
56
|
-
git pull origin release
|
|
57
|
-
git merge main
|
|
58
|
-
git push origin release
|
|
59
|
-
\`\`\`
|
|
60
|
-
3. Go to GitHub Pull Requests. You will see a **"Version Packages"** PR created by the bot.
|
|
61
|
-
4. Merge that PR.
|
|
62
|
-
5. The release is now live on npm!
|
|
63
|
-
|
|
64
|
-
## Manual Verification (Optional)
|
|
65
|
-
|
|
66
|
-
Before publishing a new version you can run:
|
|
67
|
-
|
|
68
|
-
\`\`\`bash
|
|
69
|
-
bun run build:not-apps
|
|
70
|
-
npx npm-packlist --json packages/libs/contracts
|
|
71
|
-
\`\`\`
|
|
72
|
-
|
|
73
|
-
## Rollback
|
|
74
|
-
|
|
75
|
-
If a publish fails mid-way, re-run the workflow once the issue is fixed. Already published packages are skipped automatically. Use \`npm deprecate <package>@<version>\` if we need to warn consumers about a broken release.
|
|
76
|
-
`}]);
|
|
1
|
+
import { registerDocBlocks } from "./registry.js";
|
|
2
|
+
|
|
3
|
+
//#region ../../libs/contracts/dist/docs/PUBLISHING.docblock.js
|
|
4
|
+
const PUBLISHING_DocBlocks = [{
|
|
5
|
+
id: "docs.PUBLISHING",
|
|
6
|
+
title: "Publishing ContractSpec Libraries",
|
|
7
|
+
summary: "This guide describes how we release the ContractSpec libraries to npm. We use a dual-track release system: **Stable** (manual) and **Canary** (automatic).",
|
|
8
|
+
kind: "reference",
|
|
9
|
+
visibility: "public",
|
|
10
|
+
route: "/docs/PUBLISHING",
|
|
11
|
+
tags: ["PUBLISHING"],
|
|
12
|
+
body: "# Publishing ContractSpec Libraries\n\nThis guide describes how we release the ContractSpec libraries to npm. We use a dual-track release system: **Stable** (manual) and **Canary** (automatic).\n\n## Release Tracks\n\n| Track | Branch | npm Tag | Frequency | Versioning | Use Case |\n|-------|--------|---------|-----------|------------|----------|\n| **Stable** | `release` | `latest` | Manual | SemVer (e.g., `1.7.4`) | Production, external users |\n| **Canary** | `main` | `canary` | Every Push | Snapshot (e.g., `1.7.4-canary...`) | Dev, internal testing |\n\n## Prerequisites\n\n- ✅ `NPM_TOKEN` secret is configured in GitHub (owner or automation token with _publish_ scope).\n- ✅ `GITHUB_TOKEN` (built-in) has permissions to create PRs (enabled by default in new repos).\n- ✅ For stable releases: `release` branch exists and is protected.\n\n## Canary Workflow (Automatic)\n\nEvery commit pushed to `main` triggers the `.github/workflows/publish-canary.yml` workflow.\n\n1. **Trigger**: Push to `main`.\n2. **Versioning**: Runs `changeset version --snapshot canary` to generate a temporary snapshot version.\n3. **Publish**: Packages are published to npm with the `canary` tag using `changeset publish --tag canary`.\n\n### Consuming Canary Builds\n\nTo install the latest bleeding-edge version:\n\n```bash\nnpm install @lssm/lib.contracts@canary\n# or\nbun add @lssm/lib.contracts@canary\n```\n\n## Stable Release Workflow (Manual)\n\nStable releases are managed via the `release` branch using the standard [Changesets Action](https://github.com/changesets/action).\n\n1. **Develop on `main`**: Create features and fixes.\n2. **Add Changesets**: Run `bun changeset` to document changes and impact (major/minor/patch).\n3. **Merge to `release`**: When ready to ship, open a PR from `main` to `release` or merge manually.\n4. **\"Version Packages\" PR**:\n - The GitHub Action detects new changesets and automatically creates a Pull Request titled **\"Version Packages\"**.\n - This PR contains the version bumps and updated `CHANGELOG.md` files.\n5. **Merge & Publish**:\n - Review and merge the \"Version Packages\" PR.\n - The Action runs again, detects the versions have been bumped, builds the libraries, and publishes them to npm with the `latest` tag.\n\n### Publishing Steps\n\n1. Ensure all changesets are present on `main`.\n2. Merge `main` into `release`:\n ```bash\n git checkout release\n git pull origin release\n git merge main\n git push origin release\n ```\n3. Go to GitHub Pull Requests. You will see a **\"Version Packages\"** PR created by the bot.\n4. Merge that PR.\n5. The release is now live on npm!\n\n## Manual Verification (Optional)\n\nBefore publishing a new version you can run:\n\n```bash\nbun run build:not-apps\nnpx npm-packlist --json packages/libs/contracts\n```\n\n## Rollback\n\nIf a publish fails mid-way, re-run the workflow once the issue is fixed. Already published packages are skipped automatically. Use `npm deprecate <package>@<version>` if we need to warn consumers about a broken release.\n"
|
|
13
|
+
}];
|
|
14
|
+
registerDocBlocks(PUBLISHING_DocBlocks);
|
|
15
|
+
|
|
16
|
+
//#endregion
|