robot-heads-solid 0.1.0-beta.1 → 0.1.0
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 +22 -2
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -7,10 +7,30 @@ This is an independent Solid port of the MIT-licensed React project. The renderi
|
|
|
7
7
|
## Install
|
|
8
8
|
|
|
9
9
|
~~~sh
|
|
10
|
-
bun add robot-heads-solid
|
|
10
|
+
bun add robot-heads-solid
|
|
11
11
|
~~~
|
|
12
12
|
|
|
13
|
-
The
|
|
13
|
+
The stable release is `0.1.0`. Tested with Solid 1.9.17. Solid 2 prerelease compatibility has not been verified; its current release candidate does not provide the Solid 1 `solid-js/web` and `solid-js/jsx-runtime` entry points used by the tested consumer toolchain. React, Three.js, and WebGL are not required.
|
|
14
|
+
|
|
15
|
+
## Releases
|
|
16
|
+
|
|
17
|
+
Releases publish from an annotated Git tag matching the version in the root `package.json` (for example, `vX.Y.Z-beta.N`). The tag must point to the `main` commit that introduced that package version. The release workflow runs anti-slop rule regression, lint, typecheck, build, browser E2E, and packed-consumer checks before publishing the exact verified tarball with npm provenance. Beta versions publish to the `beta` dist-tag; stable versions publish to `latest`. Versions are immutable and are never republished.
|
|
18
|
+
All package releases share one concurrency group, and the workflow requires a release version to be strictly newer than the version already on its target npm dist-tag. If tags are pushed close together, an older queued release fails rather than moving the channel backward.
|
|
19
|
+
|
|
20
|
+
One-time maintainer setup:
|
|
21
|
+
|
|
22
|
+
1. In npm package settings for `robot-heads-solid`, configure **Trusted Publishers** for GitHub Actions with repository owner `jhomra21`, repository `robot-heads-solid`, workflow filename `release.yml`, and GitHub environment `npm-publish`. Do not create or store an npm token.
|
|
23
|
+
2. In GitHub repository settings, create the `npm-publish` environment. Optionally require a reviewer to approve publication; do not add environment secrets.
|
|
24
|
+
3. Ensure GitHub Actions is allowed to run and protect the `v*` tag namespace so only release maintainers can create release tags.
|
|
25
|
+
|
|
26
|
+
For each release, merge the versioned package change to `main`, then create and push its matching tag:
|
|
27
|
+
|
|
28
|
+
~~~sh
|
|
29
|
+
git tag -a vX.Y.Z -m "vX.Y.Z"
|
|
30
|
+
git push origin vX.Y.Z
|
|
31
|
+
~~~
|
|
32
|
+
|
|
33
|
+
Do not run `npm publish` locally. If npm Trusted Publishing is not configured or the workflow binding does not match, the publish job will fail without a token fallback.
|
|
14
34
|
|
|
15
35
|
## Usage
|
|
16
36
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "robot-heads-solid",
|
|
3
|
-
"version": "0.1.0
|
|
3
|
+
"version": "0.1.0",
|
|
4
4
|
"description": "Animated TV-headed robot avatars for Solid, drawn with Canvas 2D.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"solid",
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
"license": "MIT",
|
|
17
17
|
"publishConfig": {
|
|
18
18
|
"access": "public",
|
|
19
|
-
"tag": "
|
|
19
|
+
"tag": "latest"
|
|
20
20
|
},
|
|
21
21
|
"type": "module",
|
|
22
22
|
"repository": {
|
|
@@ -77,7 +77,7 @@
|
|
|
77
77
|
"deploy": "bun run build:site && cd site && bun run deploy",
|
|
78
78
|
"prepublishOnly": "bun run check",
|
|
79
79
|
"e2e": "playwright test",
|
|
80
|
-
"e2e:consumer": "bun run build && bun pm pack --filename test-results/robot-heads-solid-
|
|
80
|
+
"e2e:consumer": "bun run build && bun pm pack --filename test-results/robot-heads-solid-0.1.0.tgz && cd e2e/consumer && bun install --force && bun run typecheck && bun run build && node ssr.mjs && cd ../.. && bunx playwright test --config playwright.consumer.config.ts"
|
|
81
81
|
},
|
|
82
82
|
"peerDependencies": {
|
|
83
83
|
"solid-js": "^1.9.0"
|