@joinskips/common 0.1.0 → 0.1.1-develop.152
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/README.md +7 -3
- package/dist/elements/skips-elements.js +1119 -1097
- package/dist/helpers/cardNote.d.ts +2 -0
- package/dist/helpers/cardNote.js +2 -0
- package/dist/hooks/useOrdersMenu.d.ts +4 -0
- package/dist/hooks/useOrdersMenu.js +34 -2
- package/dist/ui/OrdersMenu.d.ts +3 -0
- package/dist/ui/OrdersMenu.js +1 -1
- package/package.json +18 -1
package/README.md
CHANGED
|
@@ -70,7 +70,7 @@ The website's welcome is a set of parts the website places in its thread, each t
|
|
|
70
70
|
|
|
71
71
|
`fitVisibleArea` sizes the website's full-screen chat to the part of the page the phone's keyboard leaves visible.
|
|
72
72
|
|
|
73
|
-
|
|
73
|
+
The peers an app installs follow what it imports. The root, `/ui`, `/hooks`, `/chat` and `/staff` draw with React: an app that imports any of them installs `react`, `react-native` on a phone or `react-native-web` on the web, and `tailwindcss` with `uniwind` for their classes. `/helpers`, `/connection` and the `/elements` bundle, which carries its own React, need none of them. Each peer is optional, so npm checks its range only where an app installs it. Uniwind carries its own Tailwind compiler, so `uniwind` is pinned to one version. An upgrade of Uniwind or Tailwind changes the peer range here first and ships as a release.
|
|
74
74
|
|
|
75
75
|
## Commands
|
|
76
76
|
|
|
@@ -89,10 +89,10 @@ npm run storybook # http://localhost:6007, each component in light and dark
|
|
|
89
89
|
|
|
90
90
|
Work reaches `develop` by pull request, and a release pull request from `develop` to `main` ships it. A pull request into `develop` runs the same checks as one into `main`, and its ruleset takes no merge until they pass. A pull request into `main` runs the type check, the lint, the tests and the build on the `browser-checks` runner, since the stories run in Chromium.
|
|
91
91
|
|
|
92
|
-
The npm job is off, so nothing below publishes ([#11](https://github.com/joinskips/chat/issues/11)).
|
|
93
|
-
|
|
94
92
|
A push to `develop` publishes `<version>-develop.<run>` under the `develop` tag, and a push to `main` publishes `<version>` under `latest`, where `<version>` is `package.json`'s and `<run>` is the workflow run's number. A version npm already has is skipped, so a release raises `version` in its pull request into `main`.
|
|
95
93
|
|
|
94
|
+
After a `develop` publish, the release starts the `develop` deploy workflows listed in its `redeploy-develop` job, once npm's `develop` tag names the new version. It runs them as the release app, whose id and key are the `develop` environment's `RELEASE_APP_ID` and `RELEASE_APP_PRIVATE_KEY`.
|
|
95
|
+
|
|
96
96
|
```sh
|
|
97
97
|
npm install @joinskips/common@develop # develop as it is
|
|
98
98
|
npm install @joinskips/common@0.1.0 # a release
|
|
@@ -100,6 +100,10 @@ npm install @joinskips/common@0.1.0 # a release
|
|
|
100
100
|
|
|
101
101
|
`.github/workflows/release.yml` publishes through npm trusted publishing: the package's trusted publisher on npmjs.com is `joinskips/common`, workflow `release.yml`, and npm takes the run's OIDC identity with no token. npm runs trusted publishing on GitHub-hosted runners only, so that job runs on `ubuntu-24.04`.
|
|
102
102
|
|
|
103
|
+
## The model gateway
|
|
104
|
+
|
|
105
|
+
`model-gateway/` is the model gateway each app that calls a language model builds from this repository and runs as its own container, with its own models in its own order. It is no part of the npm package. [model-gateway/README.md](model-gateway/README.md) says what it fixes, the models file an app gives it and how an app runs it.
|
|
106
|
+
|
|
103
107
|
## Issues
|
|
104
108
|
|
|
105
109
|
A pull request into `develop` names the issues it ships as `Ships #N`, never `Fixes #N` or `Closes #N`, so nothing closes before the release. A release pull request into `main` lists `Closes #N` for each issue it ships, and GitHub closes them when it merges.
|