chore: fix issues with git tags when publishing a new version

[rjackson]

We have a custom script which tries to preserve exact versions between packages/, but constrained versions for examples/. That's good – that script worked.

The problem was this script was running on the postversion lifecycle hook, i.e. after lerna had committed the new version to Git and tagged the new version.

There was then some extra Git-fu in the postversion hook to try and correct that, but all it was doing is undoing the tagged commit and making a new commit. But the tag was still left pointing to the undone commit.

This commit fixes that issue by jumping out of the postversion hook and not trying any Git-fu at all. Instead, we just jump straight on the 'version' lifecycle hook: https://github.com/lerna/lerna/tree/main/libs/commands/version#lifecycle-scripts

This 'version' hook runs after Lerna has bumped all the versions, but before it commits anything to Git. Our script runs and sets exact versions and is then included in the initial commit to Git. The tags are then applied to the right commit, and there is no longer an opportunity for tags, branches, and commits to get confused.

Closes #4266

/claim #4266

🎯 Changes

• Move exact-version pinning of packages from postversion to version lerna lifecycle hook (ref)
• Remove now unnecessary Git trickery, which was causing commits & tags to become unhappy

✅ Checklist

• I have followed the steps listed in the Contributing guide.
• If necessary, I have added documentation related to the changes made.
• I have added or updated the tests related to the changes made.

Testing

Following this change, executing pnpm lerna publish...

Preserves constrained versions in examples/*/package.json:

commit 9fba6c374fa9c39bb238ce1e2a5d482b927033ad
Author: Rob Jackson <rob@rjackson.me>
Date:   Fri Apr 28 17:48:54 2023 +0100

    v10.21.3-test456.0

diff --git a/examples/cloudflare-workers/package.json b/examples/cloudflare-workers/package.json
index 74f3261e..4a8ba26b 100644
--- a/examples/cloudflare-workers/package.json
+++ b/examples/cloudflare-workers/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@examples/cloudflare-workers",
-  "version": "10.21.2",
+  "version": "10.21.3-test456.0",
   "private": true,
   "type": "module",
   "scripts": {
@@ -9,8 +9,8 @@
     "test-dev": "start-server-and-test 'wrangler dev --local' http://127.0.0.1:8787 'tsx src/client.ts'"
   },
   "dependencies": {
-    "@trpc/client": "^10.21.2",
-    "@trpc/server": "^10.21.2",
+    "@trpc/client": "^10.21.3-test456.0",
+    "@trpc/server": "^10.21.3-test456.0",
     "zod": "^3.0.0"
   },
   "devDependencies": {

Sets exact versions in packages/*/package.json:

commit 9fba6c374fa9c39bb238ce1e2a5d482b927033ad
Author: Rob Jackson <rob@rjackson.me>
Date:   Fri Apr 28 17:48:54 2023 +0100

    v10.21.3-test456.0

diff --git a/packages/client/package.json b/packages/client/package.json
index ffe8803f..29f0c523 100644
--- a/packages/client/package.json
+++ b/packages/client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@trpc/client",
-  "version": "10.21.2",
+  "version": "10.21.3-test456.0",
   "description": "tRPC Client lib",
   "author": "KATT",
   "license": "MIT",
@@ -69,11 +69,11 @@
     "links"
   ],
   "peerDependencies": {
-    "@trpc/server": "10.21.2"
+    "@trpc/server": "10.21.3-test456.0"
   },
   "devDependencies": {
     "@testing-library/dom": "^9.0.0",
-    "@trpc/server": "10.21.2",
+    "@trpc/server": "10.21.3-test456.0",
     "@types/isomorphic-fetch": "^0.0.36",
     "@types/node": "^18.7.20",
     "eslint": "^8.30.0",

Only makes a single commit:

$ git log --oneline | head -n 3
9fba6c37 v10.21.3-test456.0
f0a3bdcb Custom npm registry for testing
570a3a7e Fix issues with git tags when publishing a new version

The tag that was created points to the same commit:

git rev-list v10.21.3-test456.0 -n 1
9fba6c374fa9c39bb238ce1e2a5d482b927033ad

And finally, the published packages also contain the exact-version constraints.

To test this one, I've ran a custom npm registry locally via https://verdaccio.org/ and downloaded the published @trpc/client package.

$ npm view @trpc/client --registry http://localhost:4873/

@trpc/client@10.21.3-test456.0 | MIT | deps: none | versions: 428
tRPC Client lib
https://trpc.io

dist
.tarball: http://localhost:4873/@trpc/client/-/client-10.21.3-test456.0.tgz
.shasum: 9670ecf9408a8812255d9a9df2dc440893a5f805
.integrity: sha512-qpzzhm08+vg5n1CZVhOcbG5WjkLrplBQOx0oJMKCS4mUU1wvOacD90jgfCjgepN2mYmZFvt30jRBQE/SNUD42w==

dist-tags:
latest: 10.21.3-test456.0

published a minute ago

$ wget http://localhost:4873/@trpc/client/-/client-10.21.3-test456.0.tgz
--2023-04-28 17:51:11--  http://localhost:4873/@trpc/client/-/client-10.21.3-test456.0.tgz
Resolving localhost (localhost)... ::1, 127.0.0.1
Connecting to localhost (localhost)|::1|:4873... connected.
HTTP request sent, awaiting response... 200 OK
Length: 44748 (44K) [application/octet-stream]
Saving to: ‘client-10.21.3-test456.0.tgz’

client-10.21.3-test456.0.tgz                               100%[======================================================================================================================================>]  43.70K  --.-KB/s    in 0s

2023-04-28 17:51:11 (296 MB/s) - ‘client-10.21.3-test456.0.tgz’ saved [44748/44748]

$ tar xf client-10.21.3-test456.0.tgz

$ grep '@trpc' package/package.json
  "name": "@trpc/client",
        "@trpc/client"
    "@trpc/server": "10.21.3-test456.0"
    "@trpc/server": "10.21.3-test456.0",

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 28, 2023 4:53pm

[vercel]

@rjackson is attempting to deploy a commit to the trpc Team on Vercel.

A member of the Team first needs to authorize it.

[KATT]

Will try this! :)