perseid 0.4.0 → 0.5.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 +20 -9
- package/checksums.json +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,18 +10,28 @@ One static binary, running in your CI: an open-source and headless alternative t
|
|
|
10
10
|
|
|
11
11
|
## Get started
|
|
12
12
|
|
|
13
|
-
In the repository holding your `openapi.json`:
|
|
14
|
-
|
|
15
13
|
```sh
|
|
16
|
-
|
|
17
|
-
npx perseid
|
|
14
|
+
# in the repository that will hold your SDKs
|
|
15
|
+
npx perseid init # which SDKs, where they live → perseid.toml
|
|
16
|
+
npx perseid generate # optional local preview
|
|
17
|
+
npx perseid setup # GitHub side: workflows, releases
|
|
18
|
+
|
|
19
|
+
# spec in another repository (even private)? run there:
|
|
20
|
+
npx perseid connect acme/acme-sdks # pushes the spec on each release or change
|
|
18
21
|
```
|
|
19
22
|
|
|
20
|
-
|
|
23
|
+
| Command | Runs in | Does |
|
|
24
|
+
|---|---|---|
|
|
25
|
+
| `init` | the SDKs repository | writes `perseid.toml`, nothing else: the spec found there, the SDKs you pick, where they live |
|
|
26
|
+
| `generate` | the SDKs repository | writes the SDKs from `spec` (or `--spec <path\|url>`), starting each from its package skeleton |
|
|
27
|
+
| `setup` | the SDKs repository | plans, then sets up GitHub: SDK repositories, the App, `sdks.yml`, release files |
|
|
28
|
+
| `connect <owner/sdks-repo>` | the repository holding the spec | a deploy key and `perseid-push.yml`, pushing the spec to the SDKs repository |
|
|
21
29
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
30
|
+
With the spec and the SDKs in one repository, `connect` isn't needed. Merge the pull requests, and
|
|
31
|
+
every spec change (or every release of your API) lands as SDK pull requests, then releases. See
|
|
32
|
+
[repository layouts](docs/ci.md#repository-layouts). Also installable with
|
|
33
|
+
`curl -fsSL https://sh.meteroid.com/perseid | sh` or as the `ghcr.io/meteroid-oss/perseid` image;
|
|
34
|
+
Linux and macOS, x64 and arm64.
|
|
25
35
|
|
|
26
36
|
What your users get:
|
|
27
37
|
|
|
@@ -59,7 +69,8 @@ It powers the [Meteroid SDKs](https://github.com/meteroid-oss/meteroid-clients),
|
|
|
59
69
|
## In your CI
|
|
60
70
|
|
|
61
71
|
`perseid setup` writes the workflow for you: it runs the `meteroid-oss/perseid@v0` Action
|
|
62
|
-
on every spec change (
|
|
72
|
+
on every spec change (pushed by `perseid connect` on each release of your API, or each change),
|
|
73
|
+
and `perseid status` tells how it fares, from either repository. To set it up by hand, or on self-hosted runners and other CIs with the
|
|
63
74
|
`ghcr.io/meteroid-oss/perseid` image, see [CI and releases](docs/ci.md).
|
|
64
75
|
|
|
65
76
|
## Docs
|
package/checksums.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
|
-
"perseid-aarch64-apple-darwin.tar.gz": "
|
|
3
|
-
"perseid-aarch64-unknown-linux-musl.tar.gz": "
|
|
4
|
-
"perseid-x86_64-apple-darwin.tar.gz": "
|
|
5
|
-
"perseid-x86_64-unknown-linux-musl.tar.gz": "
|
|
2
|
+
"perseid-aarch64-apple-darwin.tar.gz": "60d972d8c8ba334c6a60ba43a78c62b37225ff3e88eb266639fe0ae5a6e17c43",
|
|
3
|
+
"perseid-aarch64-unknown-linux-musl.tar.gz": "cae7ecdba22dcdab089c44cc96da04395d3af845f8bf92bb69241465885efbec",
|
|
4
|
+
"perseid-x86_64-apple-darwin.tar.gz": "3ed57c1caa75326313203d1a8c06db11468d7ebffe794f265e131037f72bc6bf",
|
|
5
|
+
"perseid-x86_64-unknown-linux-musl.tar.gz": "7a12b53dca3eddf4bddc3cc1db0c4ff24c7ae00c7614a48c21c5a26f90f60d66"
|
|
6
6
|
}
|