Separate protobufs and set up changesets publishing workflow

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": [
+    "@livekit/changesets-changelog-github",
+    { "repo": "livekit/protocol" }
+  ],
+  "commit": false,
+  "fixed": [["github.com/livekit/protocol", "@livekit/protocol"]],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": [],
+  "privatePackages": { "version": true, "tag": true }
+}

.github/workflows/buildtest.yaml

@@ -17,41 +17,41 @@ name: Test
 on:
   workflow_dispatch:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
-    - uses: actions/cache@v4
-      with:
-        path: |
-          ~/go/pkg/mod
-          ~/go/bin
-          ~/.cache
-        key: livekit-protocol
-
-    - name: Set up Go
-      uses: actions/setup-go@v5
-      with:
-        go-version: 1.21
-
-    - name: Set up gotestfmt
-      run: go install github.com/gotesttools/gotestfmt/v2/cmd/[email protected]
-
-    - name: Download Go modules
-      run: go mod download
-
-    - name: Static Check
-      uses: amarpal/staticcheck-action@master
-      with:
-        checks: '["all", "-ST1000", "-ST1003", "-ST1020", "-ST1021", "-ST1022", "-SA1019"]'
-        install-go: false
-
-    - name: Test
-      run: |
-        set -euo pipefail
-        MallocNanoZone=0 go test -race -json -v ./... 2>&1 | gotestfmt
+      - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
+      - uses: actions/cache@v4
+        with:
+          path: |
+            ~/go/pkg/mod
+            ~/go/bin
+            ~/.cache
+          key: livekit-protocol
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: 1.21
+
+      - name: Set up gotestfmt
+        run: go install github.com/gotesttools/gotestfmt/v2/cmd/[email protected]
+
+      - name: Download Go modules
+        run: go mod download
+
+      - name: Static Check
+        uses: amarpal/staticcheck-action@master
+        with:
+          checks: '["all", "-ST1000", "-ST1003", "-ST1020", "-ST1021", "-ST1022", "-SA1019"]'
+          install-go: false
+
+      - name: Test
+        run: |
+          set -euo pipefail
+          MallocNanoZone=0 go test -race -json -v ./... 2>&1 | gotestfmt

.github/workflows/generate.yaml

@@ -17,42 +17,59 @@ name: Generate
 on:
   workflow_dispatch:
   push:
-    branches-ignore: [ main ]
+    branches-ignore: [main]
 
 jobs:
   generate:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
-
-    - name: Install Protoc
-      uses: arduino/setup-protoc@v2
-      with:
-        repo-token: ${{ secrets.GITHUB_TOKEN }}
-
-    - name: Set up Go
-      uses: actions/setup-go@v5
-      with:
-        go-version: '>=1.20'
-
-    - name: Go mod tidy
-      run: go mod tidy
-
-    - name: Install generators
-      uses: magefile/mage-action@v3
-      with:
-        version: latest
-        args: bootstrap
-
-    - name: Generate Protobuf
-      uses: magefile/mage-action@v3
-      with:
-        version: latest
-        args: proto
-
-    - name: Add changes
-      uses: EndBug/add-and-commit@v9
-      with:
-        add: '["livekit", "rpc", "infra"]'
-        default_author: github_actions
-        message: generated protobuf
+      - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
+
+      - name: Install Protoc
+        uses: arduino/setup-protoc@v2
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: ">=1.20"
+
+      - name: Go mod tidy
+        run: go mod tidy
+
+      - name: Install generators
+        uses: magefile/mage-action@v3
+        with:
+          version: latest
+          install-only: true
+
+      - name: Bootstrap
+        run: mage bootstrap
+
+      - name: Generate Protobuf
+        run: mage proto
+
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8
+
+      - name: Use Node.js 20
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "pnpm"
+
+      - name: Install JS dependencies
+        run: pnpm install
+
+      - name: Test generate JS files
+        run: |
+          pnpm --filter @livekit/protocol run generate:proto
+
+      - name: Add changes
+        uses: EndBug/add-and-commit@v9
+        with:
+          add: '["livekit", "rpc", "infra"]'
+          default_author: github_actions
+          message: generated protobuf

.github/workflows/release.yaml

@@ -0,0 +1,38 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8
+
+      - name: Use Node.js 20
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "pnpm"
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Create Release Pull Request or Publish packages
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          # This expects you to have a script called ci:publish which does a build for your packages and calls changeset publish
+          publish: pnpm ci:publish
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -14,3 +14,5 @@
 # Dependency directories (remove the comment below to include it)
 # vendor/
 .idea/
+
+node_modules/

magefile.go

@@ -101,7 +101,7 @@ func Proto() error {
 		"--twirp_opt=paths=source_relative",
 		"--plugin=go=" + protocGoPath,
 		"--plugin=twirp=" + twirpPath,
-		"-I=.",
+		"-I=./protobufs",
 	}, twirpProtoFiles...)
 	cmd := exec.Command(protoc, args...)
 	connectStd(cmd)
@@ -116,7 +116,7 @@ func Proto() error {
 		"--go-grpc_opt=paths=source_relative",
 		"--plugin=go=" + protocGoPath,
 		"--plugin=go-grpc=" + protocGrpcGoPath,
-		"-I=.",
+		"-I=./protobufs",
 	}, grpcProtoFiles...)
 	cmd = exec.Command(protoc, args...)
 	connectStd(cmd)
@@ -131,7 +131,7 @@ func Proto() error {
 		"--go-grpc_opt=paths=source_relative",
 		"--plugin=go=" + protocGoPath,
 		"--plugin=go-grpc=" + protocGrpcGoPath,
-		"-I=.",
+		"-I=./protobufs",
 	}, infraProtoFiles...)
 	cmd = exec.Command(protoc, args...)
 	connectStd(cmd)
@@ -161,7 +161,7 @@ func Proto() error {
 		"--plugin=go=" + protocGoPath,
 		"--plugin=psrpc=" + psrpcPath,
 		"-I" + psrpcDir + "/protoc-gen-psrpc/options",
-		"-I=.",
+		"-I=./protobufs",
 	}, psrpcProtoFiles...)
 	cmd = exec.Command(protoc, args...)
 	mageutil.ConnectStd(cmd)

package.json

@@ -0,0 +1,13 @@
+{
+  "name": "github.com/livekit/protocol",
+  "private": true,
+  "version": "1.10.1",
+  "scripts": {
+    "changeset": "changeset",
+    "publish:ci": "pnpm --filter @livekit/protocol run build && changeset publish"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.27.1",
+    "@livekit/changesets-changelog-github": "^0.0.4"
+  }
+}

packages/javascript/.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+src/gen
+!src/gen/version.d.ts

packages/js/package.json → packages/javascript/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livekit/protocol",
-  "version": "13.0.0",
+  "version": "1.10.1",
   "description": "",
   "type": "module",
   "main": "src/index.js",
@@ -10,8 +10,8 @@
   ],
   "scripts": {
     "generate:version": "genversion --esm --semi src/gen/version.js",
-    "generate:proto": "protoc --es_out src/gen --es_opt target=js+dts -I=../../ ../../livekit_rtc.proto ../../livekit_models.proto ../../livekit_agent.proto ../../livekit_webhook.proto ../../livekit_egress.proto ../../livekit_ingress.proto ../../livekit_sip.proto",
-    "ci:publish": "pnpm publish"
+    "generate:proto": "protoc --es_out src/gen --es_opt target=js+dts -I=../../protobufs ../../protobufs/livekit_rtc.proto ../../protobufs/livekit_models.proto ../../protobufs/livekit_agent.proto ../../protobufs/livekit_webhook.proto ../../protobufs/livekit_egress.proto ../../protobufs/livekit_ingress.proto ../../protobufs/livekit_sip.proto",
+    "build": "pnpm generate:version && pnpm generate:proto"
   },
   "keywords": [],
   "author": "LiveKit",