@xh/hoist-chat-kit 1.0.0 → 2.0.0-SNAPSHOT.1793655315348
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/CHANGELOG.md +2 -0
- package/docs/build-and-publish.md +15 -6
- package/docs/changelog-format.md +5 -3
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -12,6 +12,8 @@
|
|
|
12
12
|
3. Plain ASCII punctuation only. Use " - " for in-sentence breaks, never an em dash.
|
|
13
13
|
-->
|
|
14
14
|
|
|
15
|
+
## 2.0.0-SNAPSHOT - unreleased
|
|
16
|
+
|
|
15
17
|
## 1.0.0 - 2026-11-02
|
|
16
18
|
|
|
17
19
|
The first release of Hoist Chat Kit, a library of chat components for Hoist React applications.
|
|
@@ -76,20 +76,29 @@ be repeated once the configuration is fixed.
|
|
|
76
76
|
|
|
77
77
|
### Cut a release
|
|
78
78
|
|
|
79
|
+
`develop` always holds the next major version as a snapshot, in the Maven style that all XH
|
|
80
|
+
libraries use. After 1.0.0 ships, `package.json` reads `2.0.0-SNAPSHOT`. A release without
|
|
81
|
+
breaking changes still goes out as the next minor or patch version, and `develop` stays on the
|
|
82
|
+
same snapshot.
|
|
83
|
+
|
|
79
84
|
1. Make sure `develop` is green in CI and holds everything the release needs.
|
|
80
|
-
2.
|
|
85
|
+
2. Pick the version. A release with breaking changes is the major version that `develop` holds.
|
|
86
|
+
Any other release is the next minor or patch from the latest `v*` tag, such as `1.1.0`.
|
|
87
|
+
3. On `develop`, set the topmost `CHANGELOG.md` heading to the release version and today's date,
|
|
81
88
|
as in `## 1.1.0 - 2026-11-20`. Commit and push.
|
|
82
|
-
|
|
89
|
+
4. Fast-forward `main` to `develop` and push it:
|
|
83
90
|
```bash
|
|
84
91
|
git switch main && git merge --ff-only develop && git push
|
|
85
92
|
```
|
|
86
|
-
|
|
93
|
+
5. Run **Deploy Release** from `main` with the version. The Actions page offers the form, or:
|
|
87
94
|
```bash
|
|
88
95
|
gh workflow run deployRelease.yml --ref main -f version=1.1.0 -f is-hotfix=false
|
|
89
96
|
```
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
97
|
+
6. Back on `develop`, put a snapshot heading back on top of `CHANGELOG.md`, then push:
|
|
98
|
+
- After a major release, bump `package.json` to the next major, such as `3.0.0-SNAPSHOT`, and
|
|
99
|
+
add a matching `## 3.0.0-SNAPSHOT - unreleased` heading.
|
|
100
|
+
- After a minor or patch release, leave `package.json` as it is, and add back the
|
|
101
|
+
`## 2.0.0-SNAPSHOT - unreleased` heading above the new release entry.
|
|
93
102
|
|
|
94
103
|
### Cut a hotfix
|
|
95
104
|
|
package/docs/changelog-format.md
CHANGED
|
@@ -50,9 +50,11 @@ detailed, step-by-step upgrade instructions with before/after code examples.
|
|
|
50
50
|
* {Library} `{old} → {new}`
|
|
51
51
|
```
|
|
52
52
|
|
|
53
|
-
The topmost heading on `develop` is always the next version with a `-SNAPSHOT` suffix, as in
|
|
54
|
-
`##
|
|
55
|
-
the release version and date.
|
|
53
|
+
The topmost heading on `develop` is always the next major version with a `-SNAPSHOT` suffix, as in
|
|
54
|
+
`## 2.0.0-SNAPSHOT - unreleased`. New entries go under it. At release time, the heading becomes
|
|
55
|
+
the release version and date, which is a minor or patch version when nothing breaks. After the
|
|
56
|
+
release, a snapshot heading goes back on top. See
|
|
57
|
+
[Cut a release](./build-and-publish.md#cut-a-release).
|
|
56
58
|
|
|
57
59
|
## Section Headers
|
|
58
60
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xh/hoist-chat-kit",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "2.0.0-SNAPSHOT.1793655315348",
|
|
4
4
|
"description": "Chat with LLMs and agents in Hoist React apps: models, streaming transports, desktop components and generative UI.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|