diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3a388146..53d1ff45 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,4 +6,6 @@ Fixes # - ### Other Tasks: + - [ ] If you updated the Go SDK did you update the PackageVersion in tunnels.go +- [ ] If you updated the TS SDK did you update the dependencies in package.json for connections and management to require a dependency that is > the current published version(Found using `npm view @microsoft/dev-tunnels-contracts`). This will fix issues where yarn will pull the old version of packages and will cause mismatched dependencies. See [example PR](https://github.com/microsoft/dev-tunnels/pull/358) diff --git a/ts/README-dev.md b/ts/README-dev.md index 1f43c42f..e5efecd2 100644 --- a/ts/README-dev.md +++ b/ts/README-dev.md @@ -23,3 +23,6 @@ npm run test ``` To run/debug an individual test case or subset of test cases matching a substring, use a command similar to the following: + +## Making Changes +If you update this SDK, please update the package.json file in conenctions and management to require a dependeny that is > the current published version(You can find this with the `npm view @microsoft/dev-tunnels-contracts` command). This will fix issues where yarn will pull the old version of packages and will cause mismatched dependencies. See [example PR](https://github.com/microsoft/dev-tunnels/pull/358) \ No newline at end of file diff --git a/ts/src/connections/package.json b/ts/src/connections/package.json index 332696a5..fc968b33 100644 --- a/ts/src/connections/package.json +++ b/ts/src/connections/package.json @@ -18,8 +18,8 @@ "buffer": "^5.2.1", "debug": "^4.1.1", "vscode-jsonrpc": "^4.0.0", - "@microsoft/dev-tunnels-contracts": "^1.0.0", - "@microsoft/dev-tunnels-management": "^1.0.0", + "@microsoft/dev-tunnels-contracts": ">1.1.1", + "@microsoft/dev-tunnels-management": ">1.1.1", "@microsoft/dev-tunnels-ssh": "^3.11.36", "@microsoft/dev-tunnels-ssh-tcp": "^3.11.36", "uuid": "^3.3.3", diff --git a/ts/src/management/package.json b/ts/src/management/package.json index d3647bf8..a66e1546 100644 --- a/ts/src/management/package.json +++ b/ts/src/management/package.json @@ -18,7 +18,7 @@ "buffer": "^5.2.1", "debug": "^4.1.1", "vscode-jsonrpc": "^4.0.0", - "@microsoft/dev-tunnels-contracts": "^1.0.0", + "@microsoft/dev-tunnels-contracts": ">1.1.1", "axios": "^1.6.2" } }