@supertst/api 0.1.0 → 0.2.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 +1 -44
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,48 +5,5 @@ SDK client generated from the Supertest API schema.
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
## Generate `src/index.ts`
|
|
12
|
-
|
|
13
|
-
Regenerate the SDK from the remote OpenAPI schema:
|
|
14
|
-
|
|
15
|
-
```bash
|
|
16
|
-
bun run generate
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
This command runs `src/generate.ts` and overwrites `src/index.ts`.
|
|
20
|
-
|
|
21
|
-
## Publish flow
|
|
22
|
-
|
|
23
|
-
Publishing is automated with GitHub Actions on every push to `main`.
|
|
24
|
-
|
|
25
|
-
Versioning is manual. Before pushing a new release to `main`, update `version` in `package.json`.
|
|
26
|
-
|
|
27
|
-
Example:
|
|
28
|
-
|
|
29
|
-
```json
|
|
30
|
-
{
|
|
31
|
-
"version": "0.1.1"
|
|
32
|
-
}
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
Then push to `main` and GitHub Actions will run:
|
|
36
|
-
|
|
37
|
-
```bash
|
|
38
|
-
bun publish --access public --tolerate-republish
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
If that exact version already exists on npm, the workflow will not fail because it uses `--tolerate-republish`.
|
|
42
|
-
|
|
43
|
-
## Commits
|
|
44
|
-
|
|
45
|
-
Commits no longer control versioning.
|
|
46
|
-
|
|
47
|
-
Use any clear commit message you want, for example:
|
|
48
|
-
|
|
49
|
-
```bash
|
|
50
|
-
git commit -m "update sdk generation workflow"
|
|
51
|
-
git commit -m "fix publish action"
|
|
8
|
+
npm install @supertst/api
|
|
52
9
|
```
|