@onkernel/cli 0.3.0 → 0.3.1
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 +21 -0
- package/package.json +19 -19
package/README.md
CHANGED
|
@@ -38,6 +38,27 @@ Useful make targets:
|
|
|
38
38
|
- `make changelog` – generate/update the `CHANGELOG.md` file using **chglog**
|
|
39
39
|
- `make release` – create a release using **goreleaser** (builds archives, homebrew formula, etc. See below)
|
|
40
40
|
|
|
41
|
+
### Developing Against API Changes
|
|
42
|
+
|
|
43
|
+
A typical workflow we encounter is updating the API and integrating those changes into our CLI. The high level workflow is (update API) -> (update SDK) -> (update CLI). Detailed instructions below
|
|
44
|
+
|
|
45
|
+
1. Get added to https://www.stainless.com/ organization
|
|
46
|
+
1. For the given SDK version switch to branch changes - see https://app.stainless.com/docs/guides/branches
|
|
47
|
+
1. Update `openapi.stainless.yml` with new endpoint paths, objects, etc
|
|
48
|
+
1. Note: https://github.com/stainless-sdks/kernel-config/blob/main/openapi.stainless.yml is the source of truth. You can pull older versions as necessary
|
|
49
|
+
1. Update `openapi.yml` with your changes
|
|
50
|
+
1. Iterate in the diagnostics view until all errors are fixed
|
|
51
|
+
1. Hit `Save & build branch`
|
|
52
|
+
1. This will then create a branch in https://github.com/stainless-sdks/kernel-go
|
|
53
|
+
1. Create a release of your branch in GitHub (click ops)
|
|
54
|
+
1. Add the following to your `go.mod`:
|
|
55
|
+
|
|
56
|
+
```
|
|
57
|
+
replace github.com/onkernel/kernel-go-sdk => github.com/stainless-sdks/kernel-go $YOUR_VERSION
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
1. Run `GOPRIVATE=github.com/stainless-sdks/kernel-go go mod tidy` to pull the updated SDK
|
|
61
|
+
|
|
41
62
|
### Releasing a new version
|
|
42
63
|
|
|
43
64
|
Prerequisites:
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@onkernel/cli",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.1",
|
|
4
4
|
"description": "Kernel CLI",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"postinstall": "node install.js",
|
|
@@ -33,75 +33,75 @@
|
|
|
33
33
|
},
|
|
34
34
|
"archives": {
|
|
35
35
|
"darwin-arm64": {
|
|
36
|
-
"name": "kernel_0.3.
|
|
37
|
-
"url": "https://onkernel-public.s3.us-east-1.amazonaws.com/releases/download/cli/0.3.
|
|
36
|
+
"name": "kernel_0.3.1_darwin_arm64.tar.gz",
|
|
37
|
+
"url": "https://onkernel-public.s3.us-east-1.amazonaws.com/releases/download/cli/0.3.1/kernel_0.3.1_darwin_arm64.tar.gz",
|
|
38
38
|
"bins": [
|
|
39
39
|
"kernel"
|
|
40
40
|
],
|
|
41
41
|
"format": "tar.gz",
|
|
42
42
|
"checksum": {
|
|
43
43
|
"algorithm": "sha256",
|
|
44
|
-
"digest": "
|
|
44
|
+
"digest": "f4c4255c4be6552bf1d0da28e01003ce81df76ef6ce8d31ace9c96e5145056fd"
|
|
45
45
|
}
|
|
46
46
|
},
|
|
47
47
|
"darwin-x64": {
|
|
48
|
-
"name": "kernel_0.3.
|
|
49
|
-
"url": "https://onkernel-public.s3.us-east-1.amazonaws.com/releases/download/cli/0.3.
|
|
48
|
+
"name": "kernel_0.3.1_darwin_amd64.tar.gz",
|
|
49
|
+
"url": "https://onkernel-public.s3.us-east-1.amazonaws.com/releases/download/cli/0.3.1/kernel_0.3.1_darwin_amd64.tar.gz",
|
|
50
50
|
"bins": [
|
|
51
51
|
"kernel"
|
|
52
52
|
],
|
|
53
53
|
"format": "tar.gz",
|
|
54
54
|
"checksum": {
|
|
55
55
|
"algorithm": "sha256",
|
|
56
|
-
"digest": "
|
|
56
|
+
"digest": "42d883bfe5c4272cc81b5dd3cb85fb5f7667c4f3c243dec120f1fbc847a6ef9a"
|
|
57
57
|
}
|
|
58
58
|
},
|
|
59
59
|
"linux-arm64": {
|
|
60
|
-
"name": "kernel_0.3.
|
|
61
|
-
"url": "https://onkernel-public.s3.us-east-1.amazonaws.com/releases/download/cli/0.3.
|
|
60
|
+
"name": "kernel_0.3.1_linux_arm64.tar.gz",
|
|
61
|
+
"url": "https://onkernel-public.s3.us-east-1.amazonaws.com/releases/download/cli/0.3.1/kernel_0.3.1_linux_arm64.tar.gz",
|
|
62
62
|
"bins": [
|
|
63
63
|
"kernel"
|
|
64
64
|
],
|
|
65
65
|
"format": "tar.gz",
|
|
66
66
|
"checksum": {
|
|
67
67
|
"algorithm": "sha256",
|
|
68
|
-
"digest": "
|
|
68
|
+
"digest": "b9c5d7165ed815b4f236c19d0407fa3a07f6b33e6cb38e959bfb45a985dc0386"
|
|
69
69
|
}
|
|
70
70
|
},
|
|
71
71
|
"linux-x64": {
|
|
72
|
-
"name": "kernel_0.3.
|
|
73
|
-
"url": "https://onkernel-public.s3.us-east-1.amazonaws.com/releases/download/cli/0.3.
|
|
72
|
+
"name": "kernel_0.3.1_linux_amd64.tar.gz",
|
|
73
|
+
"url": "https://onkernel-public.s3.us-east-1.amazonaws.com/releases/download/cli/0.3.1/kernel_0.3.1_linux_amd64.tar.gz",
|
|
74
74
|
"bins": [
|
|
75
75
|
"kernel"
|
|
76
76
|
],
|
|
77
77
|
"format": "tar.gz",
|
|
78
78
|
"checksum": {
|
|
79
79
|
"algorithm": "sha256",
|
|
80
|
-
"digest": "
|
|
80
|
+
"digest": "4858205831425efae509b0f4d5d8da1ab2317c27e052a196ba7555083b371e8b"
|
|
81
81
|
}
|
|
82
82
|
},
|
|
83
83
|
"win32-arm64": {
|
|
84
|
-
"name": "kernel_0.3.
|
|
85
|
-
"url": "https://onkernel-public.s3.us-east-1.amazonaws.com/releases/download/cli/0.3.
|
|
84
|
+
"name": "kernel_0.3.1_windows_arm64.tar.gz",
|
|
85
|
+
"url": "https://onkernel-public.s3.us-east-1.amazonaws.com/releases/download/cli/0.3.1/kernel_0.3.1_windows_arm64.tar.gz",
|
|
86
86
|
"bins": [
|
|
87
87
|
"kernel.exe"
|
|
88
88
|
],
|
|
89
89
|
"format": "tar.gz",
|
|
90
90
|
"checksum": {
|
|
91
91
|
"algorithm": "sha256",
|
|
92
|
-
"digest": "
|
|
92
|
+
"digest": "21b781daee38320bb192b7b57bf59438a2a598e5d5e52d85fa596b1015370b8e"
|
|
93
93
|
}
|
|
94
94
|
},
|
|
95
95
|
"win32-x64": {
|
|
96
|
-
"name": "kernel_0.3.
|
|
97
|
-
"url": "https://onkernel-public.s3.us-east-1.amazonaws.com/releases/download/cli/0.3.
|
|
96
|
+
"name": "kernel_0.3.1_windows_amd64.tar.gz",
|
|
97
|
+
"url": "https://onkernel-public.s3.us-east-1.amazonaws.com/releases/download/cli/0.3.1/kernel_0.3.1_windows_amd64.tar.gz",
|
|
98
98
|
"bins": [
|
|
99
99
|
"kernel.exe"
|
|
100
100
|
],
|
|
101
101
|
"format": "tar.gz",
|
|
102
102
|
"checksum": {
|
|
103
103
|
"algorithm": "sha256",
|
|
104
|
-
"digest": "
|
|
104
|
+
"digest": "a58cb4c96870d1041d585f63ef32c2aeac88259462759f2f09e431cd6d222373"
|
|
105
105
|
}
|
|
106
106
|
}
|
|
107
107
|
}
|