@allwright.dev/core 0.0.1 → 0.0.22
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 +23 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -85,6 +85,7 @@ So the user-facing install model is now real for `web`, while the broader multi-
|
|
|
85
85
|
Release automation today:
|
|
86
86
|
|
|
87
87
|
- pushing a tag such as `vX.Y.Z` triggers the GitHub Actions release workflow
|
|
88
|
+
- that workflow creates the Go submodule tag `go/vX.Y.Z`, verifies the Go client in `go/`, and warms the public Go proxy for `allwright.dev`
|
|
88
89
|
- that workflow publishes the root TypeScript package to npm as `@allwright.dev/core` using npm Trusted Publishing via GitHub Actions OIDC
|
|
89
90
|
- that workflow builds both the `allwright` CLI and `allwright-surface-web` plugin for the current release matrix and uploads the archives to the matching GitHub Release
|
|
90
91
|
- `allwright plugin install web` resolves the local OS and architecture, then downloads the matching release asset
|
|
@@ -251,6 +252,7 @@ git push origin vX.Y.Z
|
|
|
251
252
|
|
|
252
253
|
That tag triggers `.github/workflows/release-surface-plugins.yml`, which builds and uploads the current web plugin archives for:
|
|
253
254
|
|
|
255
|
+
- `allwright.dev` Go module publish by creating `go/vX.Y.Z`, verifying the `go/` module, and warming `proxy.golang.org`
|
|
254
256
|
- `@allwright.dev/core` publish to npm after syncing `package.json` from the tag
|
|
255
257
|
- `allwright` CLI archives for the current OS matrix
|
|
256
258
|
- `allwright-surface-web` plugin archives for the current OS matrix
|
|
@@ -272,6 +274,27 @@ Configure npm Trusted Publishing for `@allwright.dev/core` on npmjs.com before p
|
|
|
272
274
|
|
|
273
275
|
The npm publish job uses GitHub-hosted runners and OIDC instead of an `NPM_TOKEN`, which avoids bypass-2FA tokens entirely.
|
|
274
276
|
|
|
277
|
+
## Publishing The Go Module
|
|
278
|
+
|
|
279
|
+
The Go client is published as the vanity import path `allwright.dev`, backed by the `go/` subdirectory in this repository.
|
|
280
|
+
|
|
281
|
+
You only create the root release tag manually:
|
|
282
|
+
|
|
283
|
+
```bash
|
|
284
|
+
git tag vX.Y.Z
|
|
285
|
+
git push origin vX.Y.Z
|
|
286
|
+
```
|
|
287
|
+
|
|
288
|
+
The release workflow creates the Go-specific tag `go/vX.Y.Z` on the same commit, which is the format Go requires for a module rooted in the `go/` subdirectory. The workflow also runs `go mod tidy`, verifies `go.mod` and `go.sum` stay clean, runs `go test ./...`, and asks `proxy.golang.org` for `allwright.dev@vX.Y.Z` to help the new version show up faster.
|
|
289
|
+
|
|
290
|
+
Consumers can then install or upgrade with:
|
|
291
|
+
|
|
292
|
+
```bash
|
|
293
|
+
go get allwright.dev@vX.Y.Z
|
|
294
|
+
```
|
|
295
|
+
|
|
296
|
+
The `allwright-dev/` site already serves the `go-import` metadata for `allwright.dev`, so `go get` can resolve the vanity import path back to this repository's `go/` subdirectory.
|
|
297
|
+
|
|
275
298
|
## Installer Scripts
|
|
276
299
|
|
|
277
300
|
- `scripts/install.sh`: installs the latest or requested `allwright` CLI release on Linux and macOS
|