fix(ci): add publishing tags step when publishing auxiliary packages MONGOSH-1871 (#2332)

lerna publish doesn't automatically push tags when using from-package so we have to create and push the tags manually.

Author: gagik

.github/workflows/bump-auxiliary-packages.yml

@@ -17,7 +17,7 @@ jobs:
           private-key: ${{ secrets.DEVTOOLS_BOT_PRIVATE_KEY }}
       - uses: actions/checkout@v4
         with:
-          # don't checkout a detatched HEAD
+          # don't checkout a detached HEAD
           ref: ${{ github.head_ref }}
 
           # this is important so git log can pick up on

.github/workflows/cron-tasks.yml

@@ -28,7 +28,7 @@ jobs:
 
       - uses: actions/checkout@v4
         with:
-          # don't checkout a detatched HEAD
+          # don't checkout a detached HEAD
           ref: ${{ github.head_ref }}
 
           # this is important so git log can pick up on

.github/workflows/temp-push-auxiliary-tags.yml

@@ -0,0 +1,49 @@
+# Temporary workflow just to fix currently not pushed tags for our release, will be removed.
+name: Push Tags for Auxiliary Packages
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: none # We use the github app to checkout and push tags
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: Production
+
+    steps:
+      - uses: mongodb-js/devtools-shared/actions/setup-bot-token@d638357cabd624ae626d9abb62cbac2760aea932
+        id: app-token
+        with:
+          app-id: ${{ vars.DEVTOOLS_BOT_APP_ID }}
+          private-key: ${{ secrets.DEVTOOLS_BOT_PRIVATE_KEY }}
+
+      - uses: actions/checkout@v4
+        with:
+          # don't checkout a detatched HEAD
+          ref: ${{ github.head_ref }}
+
+          # this is important so git log can pick up on
+          # the whole history to generate the list of AUTHORS
+          fetch-depth: "0"
+          token: ${{ steps.app-token.outputs.token }}
+
+      - name: "Use Node.js 20"
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.16.0
+
+      - name: Install [email protected]
+        run: npm install -g [email protected]
+
+      - name: Install Dependencies
+        run: |
+          npm ci
+
+      - name: "Pushing tags..."
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" >> ~/.npmrc
+          npm config list
+          npm run tags-auxiliary

.github/workflows/update-node-js.yaml

@@ -22,7 +22,7 @@ jobs:
 
       - uses: actions/checkout@v4
         with:
-          # don't checkout a detatched HEAD
+          # don't checkout a detached HEAD
           ref: ${{ github.head_ref }}
           token: ${{ steps.app-token.outputs.token }}
 

package.json

@@ -72,7 +72,8 @@
     "precommit": "precommit",
     "preinstall": "node scripts/sort-workspaces.js",
     "bump-auxiliary": "npm run bump-auxiliary --workspace @mongosh/build",
-    "publish-auxiliary": "npm run publish-auxiliary --workspace @mongosh/build"
+    "publish-auxiliary": "npm run publish-auxiliary --workspace @mongosh/build",
+    "tags-auxiliary": "npm run tags-auxiliary --workspace @mongosh/build"
   },
   "config": {
     "unsafe-perm": true

packages/build/package.json

@@ -30,6 +30,7 @@
     "publish": "ts-node src/index.ts publish",
     "bump-auxiliary": "ts-node src/index.ts bump --auxiliary",
     "publish-auxiliary": "ts-node src/index.ts publish --auxiliary",
+    "tags-auxiliary": "ts-node src/index.ts temp-push-auxiliary-tags --auxiliary",
     "reformat": "npm run prettier -- --write . && npm run eslint --fix"
   },
   "license": "Apache-2.0",

packages/build/src/index.ts

@@ -20,6 +20,7 @@ const validCommands: (ReleaseCommand | 'trigger-release')[] = [
   'download-crypt-shared-library',
   'download-and-list-artifacts',
   'trigger-release',
+  'temp-push-auxiliary-tags',
 ] as const;
 
 const isValidCommand = (

packages/build/src/npm-packages/index.ts

@@ -1,2 +1,3 @@
 export { bumpAuxiliaryPackages } from './bump';
 export { publishToNpm } from './publish';
+export { pushTags } from './push-tags';

packages/build/src/npm-packages/publish.spec.ts

@@ -25,62 +25,6 @@ describe('npm-packages publishToNpm', function () {
     spawnSync = sinon.stub();
   });
 
-  it('throws if mongosh is not existent when publishing all', function () {
-    const packages = [{ name: 'packageA', version: '0.7.0' }];
-    listNpmPackages.returns(packages);
-
-    expect(() =>
-      publishToNpm(
-        { isDryRun: false, useAuxiliaryPackagesOnly: false },
-        listNpmPackages,
-        markBumpedFilesAsAssumeUnchanged,
-        spawnSync
-      )
-    ).throws('mongosh package not found');
-  });
-
-  it('takes mongosh version and pushes tags', function () {
-    const packages = [
-      { name: 'packageA', version: '0.7.0' },
-      { name: 'mongosh', version: '1.2.0' },
-    ];
-    listNpmPackages.returns(packages);
-
-    publishToNpm(
-      { isDryRun: false, useAuxiliaryPackagesOnly: false },
-      listNpmPackages,
-      markBumpedFilesAsAssumeUnchanged,
-      spawnSync
-    );
-
-    expect(spawnSync).calledWith('git', ['tag', '-a', '1.2.0', '-m', '1.2.0']);
-    expect(spawnSync).calledWith('git', ['push', '--follow-tags']);
-  });
-
-  it('does not manually push tags with auxiliary packages', function () {
-    const packages = [
-      { name: 'packageA', version: '0.7.0' },
-      { name: 'mongosh', version: '1.2.0' },
-    ];
-    listNpmPackages.returns(packages);
-
-    publishToNpm(
-      { isDryRun: false, useAuxiliaryPackagesOnly: true },
-      listNpmPackages,
-      markBumpedFilesAsAssumeUnchanged,
-      spawnSync
-    );
-
-    expect(spawnSync).not.calledWith('git', [
-      'tag',
-      '-a',
-      '1.2.0',
-      '-m',
-      '1.2.0',
-    ]);
-    expect(spawnSync).not.calledWith('git', ['push', '--follow-tags']);
-  });
-
   it('calls lerna to publish packages for a real version', function () {
     const packages = [
       { name: 'packageA', version: '0.7.0' },

packages/build/src/npm-packages/publish.ts

@@ -25,15 +25,17 @@ export function publishToNpm(
       ...(isDryRun ? { npm_config_dry_run: 'true' } : {}),
     },
   };
-  let packages = listNpmPackages().filter(
+  const allReleasablePackages = listNpmPackages().filter(
     (packageConfig) => !EXCLUDE_RELEASE_PACKAGES.includes(packageConfig.name)
   );
 
-  if (useAuxiliaryPackagesOnly) {
-    packages = packages.filter(
-      (packageConfig) => !MONGOSH_RELEASE_PACKAGES.includes(packageConfig.name)
-    );
-  }
+  const packages: LernaPackageDescription[] = useAuxiliaryPackagesOnly
+    ? allReleasablePackages.filter(
+        (packageConfig) =>
+          !MONGOSH_RELEASE_PACKAGES.includes(packageConfig.name)
+      )
+    : allReleasablePackages;
+
   // Lerna requires a clean repository for a publish from-package
   // we use git update-index --assume-unchanged on files we know have been bumped
   markBumpedFilesAsAssumeUnchangedFn(packages, true);
@@ -54,24 +56,6 @@ export function publishToNpm(
   } finally {
     markBumpedFilesAsAssumeUnchangedFn(packages, false);
   }
-
-  if (!useAuxiliaryPackagesOnly) {
-    const mongoshVersion = packages.find(
-      (packageConfig) => packageConfig.name === 'mongosh'
-    )?.version;
-
-    if (!mongoshVersion) {
-      throw new Error('mongosh package not found');
-    }
-
-    spawnSync(
-      'git',
-      ['tag', '-a', mongoshVersion, '-m', mongoshVersion],
-      commandOptions
-    );
-
-    spawnSync('git', ['push', '--follow-tags'], commandOptions);
-  }
 }
 
 export function markBumpedFilesAsAssumeUnchanged(