create-koppajs 1.2.1 → 1.2.3

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.
Files changed (80) hide show
  1. package/CHANGELOG.md +55 -0
  2. package/README.md +116 -21
  3. package/bin/create-koppajs.js +10 -16
  4. package/package.json +10 -7
  5. package/template/README.md +19 -209
  6. package/template/_gitignore +0 -3
  7. package/template/index.html +1 -1
  8. package/template/package.json +9 -46
  9. package/template/public/favicon.png +0 -0
  10. package/template/public/koppajs-logo.png +0 -0
  11. package/template/src/app-view.kpa +1 -3
  12. package/template/tsconfig.json +2 -9
  13. package/template/vite.config.mjs +0 -35
  14. package/template-overlays/router/README.md +25 -203
  15. package/template-overlays/router/index.html +1 -1
  16. package/template-overlays/router/package.json +10 -47
  17. package/template-overlays/router/src/app-view.kpa +21 -78
  18. package/template-overlays/router/src/home-page.kpa +23 -60
  19. package/template-overlays/router/src/main.ts +0 -9
  20. package/template-overlays/router/src/not-found-page.kpa +16 -48
  21. package/template-overlays/router/src/router-page.kpa +34 -69
  22. package/template-overlays/router/src/style.css +5 -29
  23. package/template/AI_CONSTITUTION.md +0 -50
  24. package/template/ARCHITECTURE.md +0 -86
  25. package/template/CHANGELOG.md +0 -34
  26. package/template/CONTRIBUTING.md +0 -92
  27. package/template/DECISION_HIERARCHY.md +0 -32
  28. package/template/DEVELOPMENT_RULES.md +0 -57
  29. package/template/LICENSE +0 -201
  30. package/template/RELEASE.md +0 -230
  31. package/template/ROADMAP.md +0 -34
  32. package/template/TESTING_STRATEGY.md +0 -93
  33. package/template/_editorconfig +0 -12
  34. package/template/_github/instructions/ai-workflow.md +0 -33
  35. package/template/_github/workflows/ci.yml +0 -38
  36. package/template/_github/workflows/release.yml +0 -58
  37. package/template/_husky/commit-msg +0 -8
  38. package/template/_husky/pre-commit +0 -1
  39. package/template/_prettierignore +0 -7
  40. package/template/commitlint.config.mjs +0 -6
  41. package/template/docs/adr/0001-keep-the-starter-minimal.md +0 -32
  42. package/template/docs/adr/0002-adopt-a-living-meta-layer.md +0 -30
  43. package/template/docs/adr/0003-normalize-kpa-plugin-output.md +0 -24
  44. package/template/docs/adr/0004-adopt-an-automated-quality-baseline.md +0 -31
  45. package/template/docs/adr/0005-adopt-a-tag-driven-release-baseline.md +0 -45
  46. package/template/docs/adr/0006-adopt-commit-message-conventions.md +0 -39
  47. package/template/docs/adr/README.md +0 -37
  48. package/template/docs/adr/TEMPLATE.md +0 -18
  49. package/template/docs/architecture/module-boundaries.md +0 -48
  50. package/template/docs/meta/maintenance.md +0 -40
  51. package/template/docs/quality/quality-gates.md +0 -39
  52. package/template/docs/specs/README.md +0 -36
  53. package/template/docs/specs/TEMPLATE.md +0 -34
  54. package/template/docs/specs/app-bootstrap.md +0 -46
  55. package/template/docs/specs/counter-component.md +0 -48
  56. package/template/docs/specs/quality-workflow.md +0 -62
  57. package/template/eslint.config.mjs +0 -54
  58. package/template/playwright.config.ts +0 -31
  59. package/template/pnpm-lock.yaml +0 -3777
  60. package/template/prettier.config.mjs +0 -6
  61. package/template/public/favicon.svg +0 -15
  62. package/template/tests/e2e/app.spec.ts +0 -18
  63. package/template/tests/integration/main-bootstrap.test.ts +0 -33
  64. package/template/tests/unit/normalize-kpa-module-export.test.ts +0 -46
  65. package/template/vite.config.d.mts +0 -7
  66. package/template/vitest.config.mjs +0 -19
  67. package/template-overlays/router/ARCHITECTURE.md +0 -86
  68. package/template-overlays/router/CHANGELOG.md +0 -44
  69. package/template-overlays/router/DEVELOPMENT_RULES.md +0 -57
  70. package/template-overlays/router/ROADMAP.md +0 -34
  71. package/template-overlays/router/TESTING_STRATEGY.md +0 -67
  72. package/template-overlays/router/docs/adr/0001-keep-the-starter-minimal.md +0 -32
  73. package/template-overlays/router/docs/architecture/module-boundaries.md +0 -39
  74. package/template-overlays/router/docs/meta/maintenance.md +0 -38
  75. package/template-overlays/router/docs/specs/README.md +0 -19
  76. package/template-overlays/router/docs/specs/app-bootstrap.md +0 -42
  77. package/template-overlays/router/docs/specs/router-navigation.md +0 -41
  78. package/template-overlays/router/pnpm-lock.yaml +0 -3786
  79. package/template-overlays/router/tests/e2e/app.spec.ts +0 -38
  80. package/template-overlays/router/tests/integration/main-bootstrap.test.ts +0 -150
@@ -1,92 +0,0 @@
1
- # Contributing
2
-
3
- ## Setup
4
-
5
- Requirements:
6
-
7
- - Node.js 20.19+, 22.13+, or 24+
8
- - pnpm 10 or newer
9
-
10
- Node 23 is intentionally not part of the supported range because the current
11
- upstream frontend tooling excludes it.
12
-
13
- Install and run:
14
-
15
- ```bash
16
- pnpm install
17
- pnpm dev
18
- ```
19
-
20
- Install the Playwright browser once if you plan to run browser smoke tests locally:
21
-
22
- ```bash
23
- pnpm exec playwright install chromium
24
- ```
25
-
26
- Useful commands:
27
-
28
- ```bash
29
- pnpm lint
30
- pnpm format:check
31
- pnpm typecheck
32
- pnpm test:run
33
- pnpm test:coverage
34
- pnpm test:e2e
35
- pnpm check
36
- pnpm validate
37
- pnpm release:check
38
- pnpm build
39
- pnpm serve
40
- ```
41
-
42
- Commit messages use Conventional Commits.
43
- Examples:
44
-
45
- ```text
46
- feat: add release baseline
47
- docs: update contributing guide
48
- fix: align bootstrap docs
49
- ```
50
-
51
- ## Workflow
52
-
53
- 1. Read [DECISION_HIERARCHY.md](./DECISION_HIERARCHY.md), [ARCHITECTURE.md](./ARCHITECTURE.md), and any relevant spec or ADR before changing source files.
54
- 2. For non-trivial work, update or create the relevant spec in [docs/specs](./docs/specs) first.
55
- 3. If the change alters architecture, tooling, public tags, or repository workflow, add or update an ADR in [docs/adr](./docs/adr).
56
- 4. Implement the smallest change that satisfies the spec.
57
- 5. Run the applicable quality gates from [TESTING_STRATEGY.md](./TESTING_STRATEGY.md). Use `pnpm check` for the local baseline and `pnpm validate` before merge when the UI, bootstrap, or tooling changed.
58
- 6. If the change touches versioning, changelog, or release automation, update `CHANGELOG.md`, `RELEASE.md`, and the affected workflow in the same change.
59
- 7. Update architecture, development, testing, and README docs when the actual project state changes.
60
-
61
- ## Releases
62
-
63
- - Release notes live in [`CHANGELOG.md`](./CHANGELOG.md).
64
- - The maintainer release procedure lives in [`RELEASE.md`](./RELEASE.md).
65
- - Releases are prepared on `develop`, moved through `release/*`, merged into `main`, and tagged as `vX.Y.Z`.
66
- - The release workflow creates GitHub Releases only. The repository starts
67
- `private`, so no npm publish step is configured by default.
68
- - Run `pnpm release:check` before cutting a release tag.
69
-
70
- ## Commit policy
71
-
72
- - Commit messages are validated by `.husky/commit-msg` using `commitlint`.
73
- - Use Conventional Commits such as `feat: ...`, `fix: ...`, `docs: ...`, `test: ...`, `ci: ...`, or `chore: ...`.
74
- - Keep the commit header at 72 characters or fewer.
75
- - Merge, revert, `fixup!`, and `squash!` commits may bypass validation when Git creates them automatically.
76
-
77
- ## Pull request expectations
78
-
79
- - Keep the starter minimal unless expansion is explicitly approved.
80
- - Explain user-visible behavior changes and architecture-impacting decisions.
81
- - Do not silently swap dependency sources, add build tools, or introduce new subsystems.
82
- - Keep docs and code aligned in the same change.
83
- - Keep hooks fast; heavy validation belongs in `pnpm validate` and CI, not in `pre-commit`.
84
-
85
- ## AI-assisted contributions
86
-
87
- AI contributors follow the same rules as humans:
88
-
89
- - read governing docs before editing,
90
- - prefer existing patterns,
91
- - do not invent architecture casually,
92
- - update the meta layer whenever structure or rules change.
@@ -1,32 +0,0 @@
1
- # Decision Hierarchy
2
-
3
- When repository documents conflict, use this order of precedence.
4
-
5
- 1. Approved specifications in [`docs/specs/`](./docs/specs)
6
- 2. Architecture Decision Records in [`docs/adr/`](./docs/adr)
7
- 3. [`AI_CONSTITUTION.md`](./AI_CONSTITUTION.md)
8
- 4. [`ARCHITECTURE.md`](./ARCHITECTURE.md) and supporting architecture docs in [`docs/architecture/`](./docs/architecture)
9
- 5. [`DEVELOPMENT_RULES.md`](./DEVELOPMENT_RULES.md) and [`TESTING_STRATEGY.md`](./TESTING_STRATEGY.md)
10
- 6. Quality and maintenance guidance in [`docs/quality/`](./docs/quality) and [`docs/meta/`](./docs/meta)
11
- 7. Contributor guidance and examples in [`CONTRIBUTING.md`](./CONTRIBUTING.md), [`README.md`](./README.md), and inline comments
12
-
13
- ## Interpretation rules
14
-
15
- - The most specific document wins when two documents have the same rank.
16
- - A newer document does not override a higher-ranked document by default.
17
- - If a lower-ranked document is wrong, fix it instead of following it.
18
- - If no applicable spec exists for a non-trivial change, create or update one before implementation.
19
- - If a change would invalidate an ADR, create a superseding ADR instead of silently drifting away from it.
20
-
21
- ## Required reading order for non-trivial changes
22
-
23
- 1. This file
24
- 2. [AI_CONSTITUTION.md](./AI_CONSTITUTION.md)
25
- 3. [ARCHITECTURE.md](./ARCHITECTURE.md)
26
- 4. Relevant spec in [docs/specs](./docs/specs)
27
- 5. Relevant ADR in [docs/adr](./docs/adr)
28
- 6. [DEVELOPMENT_RULES.md](./DEVELOPMENT_RULES.md) and [TESTING_STRATEGY.md](./TESTING_STRATEGY.md)
29
-
30
- ## Escalation rule
31
-
32
- When a change creates a new lasting rule, boundary, or tradeoff, encode it as a spec or ADR rather than relying on chat history or commit messages.
@@ -1,57 +0,0 @@
1
- # Development Rules
2
-
3
- ## Scope
4
-
5
- These rules describe how code and documentation are expected to evolve in this repository.
6
-
7
- ## Source layout rules
8
-
9
- - Keep `index.html` as a static shell with asset references and the single root element.
10
- - Keep `src/main.ts` limited to bootstrap concerns: imports, `Core.take(...)` registrations, and the single public bootstrap call via `Core()`.
11
- - Use `.kpa` files for UI composition, local component state, and component-scoped CSS.
12
- - If logic becomes reusable, asynchronous, or branch-heavy, move it into `.ts` modules under `src/`.
13
- - Keep `public/` for static assets only.
14
- - Keep automated tests under `tests/`, split by `unit`, `integration`, and `e2e` only when each level is meaningfully used.
15
-
16
- ## Naming conventions
17
-
18
- - Custom element names must be kebab-case.
19
- - Root-level application components should use `app-` prefixes when they represent app shells or app-wide structure.
20
- - Component filenames should match their primary exported or registered concept.
21
- - New files and folders should use descriptive names over abbreviations.
22
-
23
- ## Dependency rules
24
-
25
- - Runtime dependencies must be justified by a concrete need in a spec or ADR.
26
- - Prefer browser APIs and KoppaJS primitives before adding helper libraries.
27
- - Keep this repository wired to published npm packages unless there is an explicit ADR stating otherwise.
28
- - Build tooling changes must update contributor docs and architecture docs in the same change.
29
- - Quality tooling must stay proportionate to the starter. Prefer one clear tool per job over overlapping stacks.
30
-
31
- ## Coding patterns
32
-
33
- - Favor simple, local state over premature abstraction.
34
- - Keep methods short and named by behavior.
35
- - Avoid hidden side effects during import.
36
- - Keep CSS local to components unless the style truly applies application-wide.
37
- - Preserve strict TypeScript settings; do not weaken `tsconfig.json` to work around errors.
38
- - Give interactive controls stable accessible names when feasible so smoke tests can target public semantics instead of brittle selectors.
39
- - Keep Playwright assertions user-facing. Implementation-detail checks belong in Vitest, not in browser tests.
40
-
41
- ## Forbidden without a spec and ADR
42
-
43
- - Introducing routing
44
- - Adding global state containers
45
- - Adding network or persistence layers
46
- - Introducing SSR, multi-page bootstraps, or multiple root entries
47
- - Switching dependency sourcing from npm packages to local monorepo links
48
- - Expanding the starter into a multi-feature demo application
49
- - Adding heavyweight hooks that run the entire suite on every commit
50
-
51
- ## Documentation obligations
52
-
53
- - Update [ARCHITECTURE.md](./ARCHITECTURE.md) when source layout or runtime flow changes.
54
- - Update [TESTING_STRATEGY.md](./TESTING_STRATEGY.md) when quality gates or tooling change.
55
- - Update or create a spec in [docs/specs](./docs/specs) for user-visible changes.
56
- - Add an ADR in [docs/adr](./docs/adr) for durable technical decisions.
57
- - Update [docs/quality/quality-gates.md](./docs/quality/quality-gates.md) when scripts, hooks, CI checks, or browser-smoke expectations change.
package/template/LICENSE DELETED
@@ -1,201 +0,0 @@
1
- Apache License
2
- Version 2.0, January 2004
3
- http://www.apache.org/licenses/
4
-
5
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
-
7
- 1. Definitions.
8
-
9
- "License" shall mean the terms and conditions for use, reproduction,
10
- and distribution as defined by Sections 1 through 9 of this document.
11
-
12
- "Licensor" shall mean the copyright owner or entity authorized by
13
- the copyright owner that is granting the License.
14
-
15
- "Legal Entity" shall mean the union of the acting entity and all
16
- other entities that control, are controlled by, or are under common
17
- control with that entity. For the purposes of this definition,
18
- "control" means (i) the power, direct or indirect, to cause the
19
- direction or management of such entity, whether by contract or
20
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
- outstanding shares, or (iii) beneficial ownership of such entity.
22
-
23
- "You" (or "Your") shall mean an individual or Legal Entity
24
- exercising permissions granted by this License.
25
-
26
- "Source" form shall mean the preferred form for making modifications,
27
- including but not limited to software source code, documentation
28
- source, and configuration files.
29
-
30
- "Object" form shall mean any form resulting from mechanical
31
- transformation or translation of a Source form, including but
32
- not limited to compiled object code, generated documentation,
33
- and conversions to other media types.
34
-
35
- "Work" shall mean the work of authorship, whether in Source or
36
- Object form, made available under the License, as indicated by a
37
- copyright notice that is included in or attached to the work
38
- (an example is provided in the Appendix below).
39
-
40
- "Derivative Works" shall mean any work, whether in Source or Object
41
- form, that is based on (or derived from) the Work and for which the
42
- editorial revisions, annotations, elaborations, or other modifications
43
- represent, as a whole, an original work of authorship. For the purposes
44
- of this License, Derivative Works shall not include works that remain
45
- separable from, or merely link (or bind by name) to the interfaces of,
46
- the Work and Derivative Works thereof.
47
-
48
- "Contribution" shall mean any work of authorship, including
49
- the original version of the Work and any modifications or additions
50
- to that Work or Derivative Works thereof, that is intentionally
51
- submitted to Licensor for inclusion in the Work by the copyright owner
52
- or by an individual or Legal Entity authorized to submit on behalf of
53
- the copyright owner. For the purposes of this definition, "submitted"
54
- means any form of electronic, verbal, or written communication sent
55
- to the Licensor or its representatives, including but not limited to
56
- communication on electronic mailing lists, source code control systems,
57
- and issue tracking systems that are managed by, or on behalf of, the
58
- Licensor for the purpose of discussing and improving the Work, but
59
- excluding communication that is conspicuously marked or otherwise
60
- designated in writing by the copyright owner as "Not a Contribution."
61
-
62
- "Contributor" shall mean Licensor and any individual or Legal Entity
63
- on behalf of whom a Contribution has been received by Licensor and
64
- subsequently incorporated within the Work.
65
-
66
- 2. Grant of Copyright License. Subject to the terms and conditions of
67
- this License, each Contributor hereby grants to You a perpetual,
68
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
- copyright license to reproduce, prepare Derivative Works of,
70
- publicly display, publicly perform, sublicense, and distribute the
71
- Work and such Derivative Works in Source or Object form.
72
-
73
- 3. Grant of Patent License. Subject to the terms and conditions of
74
- this License, each Contributor hereby grants to You a perpetual,
75
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
- (except as stated in this section) patent license to make, have made,
77
- use, offer to sell, sell, import, and otherwise transfer the Work,
78
- where such license applies only to those patent claims licensable
79
- by such Contributor that are necessarily infringed by their
80
- Contribution(s) alone or by combination of their Contribution(s)
81
- with the Work to which such Contribution(s) was submitted. If You
82
- institute patent litigation against any entity (including a
83
- cross-claim or counterclaim in a lawsuit) alleging that the Work
84
- or a Contribution incorporated within the Work constitutes direct
85
- or contributory patent infringement, then any patent licenses
86
- granted to You under this License for that Work shall terminate
87
- as of the date such litigation is filed.
88
-
89
- 4. Redistribution. You may reproduce and distribute copies of the
90
- Work or Derivative Works thereof in any medium, with or without
91
- modifications, and in Source or Object form, provided that You
92
- meet the following conditions:
93
-
94
- (a) You must give any other recipients of the Work or
95
- Derivative Works a copy of this License; and
96
-
97
- (b) You must cause any modified files to carry prominent notices
98
- stating that You changed the files; and
99
-
100
- (c) You must retain, in the Source form of any Derivative Works
101
- that You distribute, all copyright, patent, trademark, and
102
- attribution notices from the Source form of the Work,
103
- excluding those notices that do not pertain to any part of
104
- the Derivative Works; and
105
-
106
- (d) If the Work includes a "NOTICE" text file as part of its
107
- distribution, then any Derivative Works that You distribute must
108
- include a readable copy of the attribution notices contained
109
- within such NOTICE file, excluding those notices that do not
110
- pertain to any part of the Derivative Works, in at least one
111
- of the following places: within a NOTICE text file distributed
112
- as part of the Derivative Works; within the Source form or
113
- documentation, if provided along with the Derivative Works; or,
114
- within a display generated by the Derivative Works, if and
115
- wherever such third-party notices normally appear. The contents
116
- of the NOTICE file are for informational purposes only and
117
- do not modify the License. You may add Your own attribution
118
- notices within Derivative Works that You distribute, alongside
119
- or as an addendum to the NOTICE text from the Work, provided
120
- that such additional attribution notices cannot be construed
121
- as modifying the License.
122
-
123
- You may add Your own copyright statement to Your modifications and
124
- may provide additional or different license terms and conditions
125
- for use, reproduction, or distribution of Your modifications, or
126
- for any such Derivative Works as a whole, provided Your use,
127
- reproduction, and distribution of the Work otherwise complies with
128
- the conditions stated in this License.
129
-
130
- 5. Submission of Contributions. Unless You explicitly state otherwise,
131
- any Contribution intentionally submitted for inclusion in the Work
132
- by You to the Licensor shall be under the terms and conditions of
133
- this License, without any additional terms or conditions.
134
- Notwithstanding the above, nothing herein shall supersede or modify
135
- the terms of any separate license agreement you may have executed
136
- with Licensor regarding such Contributions.
137
-
138
- 6. Trademarks. This License does not grant permission to use the trade
139
- names, trademarks, service marks, or product names of the Licensor,
140
- except as required for reasonable and customary use in describing the
141
- origin of the Work and reproducing the content of the NOTICE file.
142
-
143
- 7. Disclaimer of Warranty. Unless required by applicable law or
144
- agreed to in writing, Licensor provides the Work (and each
145
- Contributor provides its Contributions) on an "AS IS" BASIS,
146
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
- implied, including, without limitation, any warranties or conditions
148
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
- PARTICULAR PURPOSE. You are solely responsible for determining the
150
- appropriateness of using or redistributing the Work and assume any
151
- risks associated with Your exercise of permissions under this License.
152
-
153
- 8. Limitation of Liability. In no event and under no legal theory,
154
- whether in tort (including negligence), contract, or otherwise,
155
- unless required by applicable law (such as deliberate and grossly
156
- negligent acts) or agreed to in writing, shall any Contributor be
157
- liable to You for damages, including any direct, indirect, special,
158
- incidental, or consequential damages of any character arising as a
159
- result of this License or out of the use or inability to use the
160
- Work (including but not limited to damages for loss of goodwill,
161
- work stoppage, computer failure or malfunction, or any and all
162
- other commercial damages or losses), even if such Contributor
163
- has been advised of the possibility of such damages.
164
-
165
- 9. Accepting Warranty or Additional Liability. While redistributing
166
- the Work or Derivative Works thereof, You may choose to offer,
167
- and charge a fee for, acceptance of support, warranty, indemnity,
168
- or other liability obligations and/or rights consistent with this
169
- License. However, in accepting such obligations, You may act only
170
- on Your own behalf and on Your sole responsibility, not on behalf
171
- of any other Contributor, and only if You agree to indemnify,
172
- defend, and hold each Contributor harmless for any liability
173
- incurred by, or claims asserted against, such Contributor by reason
174
- of your accepting any such warranty or additional liability.
175
-
176
- END OF TERMS AND CONDITIONS
177
-
178
- APPENDIX: How to apply the Apache License to your work.
179
-
180
- To apply the Apache License to your work, attach the following
181
- boilerplate notice, with the fields enclosed by brackets "[]"
182
- replaced with your own identifying information. (Don't include
183
- the brackets!) The text should be enclosed in the appropriate
184
- comment syntax for the file format. We also recommend that a
185
- file or class name and description of purpose be included on the
186
- same "printed page" as the copyright notice for easier
187
- identification within third-party archives.
188
-
189
- Copyright 2026 Bastian Bensch
190
-
191
- Licensed under the Apache License, Version 2.0 (the "License");
192
- you may not use this file except in compliance with the License.
193
- You may obtain a copy of the License at
194
-
195
- http://www.apache.org/licenses/LICENSE-2.0
196
-
197
- Unless required by applicable law or agreed to in writing, software
198
- distributed under the License is distributed on an "AS IS" BASIS,
199
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
- See the License for the specific language governing permissions and
201
- limitations under the License.
@@ -1,230 +0,0 @@
1
- # Release Process for `__PROJECT_NAME__`
2
-
3
- This document describes the repository-specific release workflow for
4
- `__PROJECT_NAME__`.
5
-
6
- The project uses a manual, tag-driven release process.
7
- Only tagged versions are official releases.
8
-
9
- The effective flow is:
10
-
11
- 1. Finalize the release content on `develop`
12
- 2. Update `package.json` and `CHANGELOG.md`
13
- 3. Validate the release candidate locally
14
- 4. Create a `release/*` branch from that state
15
- 5. Merge the release branch into `main`
16
- 6. Tag the release commit on `main` as `vX.Y.Z`
17
- 7. Push the tag
18
- 8. Let GitHub Actions validate and create the GitHub Release
19
- 9. Merge the updated `main` back into `develop`
20
-
21
- ---
22
-
23
- ## Release Model
24
-
25
- This repository does not use automated versioning tools such as Changesets or
26
- semantic-release.
27
-
28
- The release is controlled by:
29
-
30
- - the version in `package.json`
31
- - the release entry in `CHANGELOG.md`
32
- - the merge of the release-ready state into `main`
33
- - the Git tag in the form `vX.Y.Z`
34
- - the GitHub Actions workflow in `.github/workflows/release.yml`
35
-
36
- Important consequences:
37
-
38
- - A merge to `main` alone does not create a release
39
- - A tag triggers the release workflow
40
- - The tag version must exactly match `package.json`
41
- - The tag must point to the release commit on `main`
42
- - After a successful release, `main` should be merged back into `develop`
43
-
44
- The included release workflow creates GitHub Releases only and does not publish
45
- to npm by default.
46
-
47
- If this project later needs npm publishing or another release target, update
48
- this file, `package.json`, and `.github/workflows/release.yml` in the same
49
- change.
50
-
51
- Do not tag `develop`.
52
- Do not tag the `release/*` branch.
53
- Tag only the release commit that is already on `main`.
54
-
55
- ---
56
-
57
- ## Preconditions
58
-
59
- Before cutting a release, ensure all of the following are true:
60
-
61
- - The intended release scope is already complete on `develop`
62
- - `package.json` contains the target version
63
- - `CHANGELOG.md` contains the corresponding release notes
64
- - The lockfile is up to date
65
- - The release content has been reviewed
66
-
67
- Tooling expectations for local verification:
68
-
69
- - Node.js 20.19+, 22.13+, or 24+
70
- - pnpm 10 or newer
71
-
72
- Node 23 is intentionally not treated as supported here because the current
73
- upstream frontend toolchain excludes it.
74
-
75
- This repository also enforces `engine-strict=true` in `.npmrc`, so incompatible
76
- Node.js or pnpm versions should be treated as a release blocker.
77
-
78
- ---
79
-
80
- ## Local Validation Before Branching
81
-
82
- Before creating the release branch, validate the exact release candidate
83
- locally.
84
-
85
- Recommended commands:
86
-
87
- ```bash
88
- pnpm install
89
- pnpm release:check
90
- ```
91
-
92
- `pnpm release:check` runs the same full validation path used by the release
93
- workflow, including Playwright.
94
-
95
- If Chromium is not installed locally yet, install it once:
96
-
97
- ```bash
98
- pnpm exec playwright install chromium
99
- ```
100
-
101
- ---
102
-
103
- ## Step-by-Step Release Workflow
104
-
105
- ### 1. Finalize the release on `develop`
106
-
107
- Ensure `develop` already contains the exact release content.
108
-
109
- Typical release preparation includes:
110
-
111
- - updating `package.json` from the previous version to the next release version
112
- - moving the relevant notes into the final section in `CHANGELOG.md`
113
- - committing any last release fixes
114
-
115
- Make sure the release-ready state is committed before creating `release/*`.
116
-
117
- ### 2. Create the `release/*` branch
118
-
119
- Create a release branch from the validated `develop` state.
120
-
121
- Example:
122
-
123
- ```bash
124
- git checkout develop
125
- git pull
126
- git checkout -b release/X.Y.Z
127
- ```
128
-
129
- ### 3. Merge the release branch into `main`
130
-
131
- Merge `release/*` into `main` using the repository's normal process.
132
-
133
- The critical requirement is:
134
-
135
- - `main` must contain the final release commit before tagging
136
-
137
- Conceptually:
138
-
139
- ```bash
140
- git checkout main
141
- git pull
142
- git merge --no-ff release/X.Y.Z
143
- ```
144
-
145
- ### 4. Tag the release commit on `main`
146
-
147
- After the release branch has been merged, create the Git tag on the release
148
- commit that is now on `main`.
149
-
150
- Example:
151
-
152
- ```bash
153
- git checkout main
154
- git pull
155
- git tag vX.Y.Z
156
- ```
157
-
158
- The tag format is mandatory:
159
-
160
- - `vX.Y.Z` is valid
161
- - `X.Y.Z` is not valid for this workflow
162
-
163
- ### 5. Push `main` and the tag
164
-
165
- Push the merged `main` branch and then the tag.
166
-
167
- Example:
168
-
169
- ```bash
170
- git push origin main
171
- git push origin vX.Y.Z
172
- ```
173
-
174
- ### 6. Wait for the release workflow to finish
175
-
176
- Verify that:
177
-
178
- - the GitHub Actions release workflow passed
179
- - the GitHub Release was created
180
- - the version-check step confirmed tag and `package.json` alignment
181
-
182
- ### 7. Merge `main` back into `develop`
183
-
184
- After the release has completed successfully, merge the updated `main` back
185
- into `develop`.
186
-
187
- Conceptually:
188
-
189
- ```bash
190
- git checkout develop
191
- git pull
192
- git merge --no-ff main
193
- ```
194
-
195
- ---
196
-
197
- ## GitHub Workflow Behavior
198
-
199
- The workflow `.github/workflows/release.yml` runs on pushed tags matching
200
- `vX.Y.Z`.
201
-
202
- For each matching tag it will:
203
-
204
- 1. install dependencies
205
- 2. install the Playwright Chromium browser
206
- 3. run `pnpm validate`
207
- 4. verify that the tag version matches `package.json`
208
- 5. create a GitHub Release with generated release notes
209
-
210
- If any step fails, the release job stops immediately.
211
-
212
- ---
213
-
214
- ## Maintainer Checklist
215
-
216
- Use this as the maintainer checklist for every release:
217
-
218
- 1. Verify the release scope on `develop`
219
- 2. Update `package.json`
220
- 3. Update `CHANGELOG.md`
221
- 4. Run `pnpm release:check`
222
- 5. Create `release/*` from `develop`
223
- 6. Merge `release/*` into `main`
224
- 7. Confirm the merged commit on `main` has the correct version and changelog
225
- 8. Create the `vX.Y.Z` tag on `main`
226
- 9. Push `main`
227
- 10. Push the tag
228
- 11. Watch the GitHub Actions release workflow
229
- 12. Verify the GitHub Release exists
230
- 13. Merge `main` back into `develop`
@@ -1,34 +0,0 @@
1
- # Roadmap
2
-
3
- This roadmap describes intended directions, not guaranteed delivery dates.
4
-
5
- ## Current priorities
6
-
7
- - Keep the starter minimal and production-like.
8
- - Preserve a clear bootstrap path for new KoppaJS users.
9
- - Keep the meta layer synchronized with the actual repository.
10
-
11
- ## Near-term opportunities
12
-
13
- - Add a lightweight automated test runner when the repository gains logic that warrants it.
14
- - Replace or harden any documentation that still assumes old monorepo-linked dependencies.
15
- - Add more feature specs only when new starter capabilities are intentionally introduced.
16
-
17
- ## Longer-term expansion triggers
18
-
19
- These should happen only with a spec and ADR:
20
-
21
- - routing
22
- - async data fetching
23
- - persistence
24
- - richer component examples
25
- - CI automation
26
-
27
- ## Meta-layer maintenance
28
-
29
- Every release or architecture-changing change should answer:
30
-
31
- - Does the architecture document still match the code?
32
- - Did any new decision deserve an ADR?
33
- - Did testing expectations change?
34
- - Did contributor instructions stay accurate?