@togatherlabs/event-sdk 1.0.6 → 1.0.7
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 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,10 +6,11 @@ This repository contains **event schemas** for the toGather event-driven backend
|
|
|
6
6
|
## Table of Contents
|
|
7
7
|
|
|
8
8
|
1. [Directory Structure](#directory-structure)
|
|
9
|
-
2. [SDK Development](#development)
|
|
9
|
+
2. [SDK Development](#sdk-development)
|
|
10
10
|
* [Adding New Proto Files](#adding-new-proto-files)
|
|
11
11
|
* [Linting](#linting)
|
|
12
12
|
* [Code Generation](#code-generation)
|
|
13
|
+
* [Publishing Package](#publishing-package)
|
|
13
14
|
3. [Using Generated Code](#using-generated-code)
|
|
14
15
|
* [TypeScript](#typescript)
|
|
15
16
|
* [Python](#python)
|
|
@@ -41,7 +42,7 @@ proto/user/create/v1/user.proto
|
|
|
41
42
|
|
|
42
43
|
|
|
43
44
|
|
|
44
|
-
## Development
|
|
45
|
+
## SDK Development
|
|
45
46
|
|
|
46
47
|
### Adding New Proto Files
|
|
47
48
|
|
|
@@ -89,6 +90,23 @@ The generated code is placed in the `gen/` directory:
|
|
|
89
90
|
|
|
90
91
|
> **Tip:** Keep `buf.gen.yaml` updated if you add new languages or plugins.
|
|
91
92
|
|
|
93
|
+
### Publishing Package
|
|
94
|
+
|
|
95
|
+
To publish the package, run the following command:
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
pnpm run release
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
This command performs the following steps:
|
|
102
|
+
- Deletes the old build artifacts.
|
|
103
|
+
- Lints the proto files.
|
|
104
|
+
- Generates new code for TypeScript and Python.
|
|
105
|
+
- Patches the npm version.
|
|
106
|
+
- Publishes the package to the registry.
|
|
107
|
+
|
|
108
|
+
> **Note:** Ensure all changes are committed and tested before running this command.
|
|
109
|
+
|
|
92
110
|
|
|
93
111
|
## Using Generated Code
|
|
94
112
|
|
package/package.json
CHANGED