feat: update docs, remove triggers, requrie publisher, use tag-based workflow

Author: gagik

.evergreen.yml

@@ -4233,6 +4233,7 @@ functions:
           PAPERTRAIL_SECRET_KEY: ${papertrail_secret_key}
           EVERGREEN_TASK_ID: ${task_id}
           EVERGREEN_EXECUTION: ${execution}
+          EVERGREEN_AUTHOR: ${author}
         working_dir: src
         shell: bash
         script: |
@@ -4246,9 +4247,8 @@ functions:
 
           # Set the release publisher
           submitter=$(node -p 'JSON.parse(fs.readFileSync("packages/cli-repl/package.json")).releasePublisher')
-          if [ -z "$submitter" ] || [ "$submitter" == "undefined" ]; then
-            echo "releasePublisher is not set"
-            exit 1
+          if [ -z "$submitter" ] || [ "$submitter" == "undefined" ] || [ "$submitter" == "null" ]; then
+            submitter="${EVERGREEN_AUTHOR}"
           fi
 
           echo "Setting version for papertrail to $tag, with product ${product} and submitter ${submitter}"

.evergreen/evergreen.yml.in

@@ -878,10 +878,15 @@ functions:
           PAPERTRAIL_SECRET_KEY: ${papertrail_secret_key}
           EVERGREEN_TASK_ID: ${task_id}
           EVERGREEN_EXECUTION: ${execution}
+          EVERGREEN_AUTHOR: ${author}
         working_dir: src
         shell: bash
         script: |
           set -e
+          echo "X-PAPERTRAIL-KEY-ID: ${PAPERTRAIL_KEY_ID}" > .papertrail.headers
+          echo "X-PAPERTRAIL-SECRET-KEY: ${PAPERTRAIL_SECRET_KEY}" >> .papertrail.headers
+
+          set -x
           ls -lh dist/
           if [ x"${triggered_by_git_tag}" == x"" ]; then
             tag=$(git describe --tags --always --dirty)
@@ -891,16 +896,12 @@ functions:
 
           # Set the release publisher
           submitter=$(node -p 'JSON.parse(fs.readFileSync("packages/cli-repl/package.json")).releasePublisher')
-          if [ -z "$submitter" ] || [ "$submitter" == "undefined" ]; then
-            echo "releasePublisher is not set"
-            exit 1
+          if [ -z "$submitter" ] || [ "$submitter" == "undefined" ] || [ "$submitter" == "null" ]; then
+            echo "Using evergreen author as submitter"
+            submitter="${EVERGREEN_AUTHOR}"
           fi
 
           echo "Setting version for papertrail to $tag, with product ${product} and submitter ${submitter}"
- 
-          echo "X-PAPERTRAIL-KEY-ID: ${PAPERTRAIL_KEY_ID}" > .papertrail.headers
-          echo "X-PAPERTRAIL-SECRET-KEY: ${PAPERTRAIL_SECRET_KEY}" >> .papertrail.headers
-
 
           for file in src/dist/* ; do
            if [ -f "$file" ]; then

.github/workflows/merge-release-pr.yml

@@ -0,0 +1,35 @@
+name: Merge mongosh Release PR
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  prepare-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: mongodb-js/devtools-shared/actions/setup-bot-token@main
+        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: Merge Pull Request
+        shell: bash
+        env:
+          MONGOSH_RELEASE_VERSION: ${{ env.NEXT_VERSION }}
+          GH_TOKEN: ${{ steps.app-token.outputs.token }}
+        run: |
+           gh pr merge release/${{ github.ref_name }} --squash

.github/workflows/prepare-release-mongosh.yml

@@ -104,7 +104,7 @@ jobs:
         with:
           token: ${{ steps.app-token.outputs.token }}
           commit-message: "chore(release): prepare for mongosh v${NEXT_VERSION} ${{ github.event.inputs.jiraTicket }}"
-          branch: release/${NEXT_VERSION}
+          branch: release/${RELEASE_TAG}
           title: "chore(release): prepare for mongosh v${NEXT_VERSION} ${{ github.event.inputs.jiraTicket }}"
           body: |
             - [${{ github.event.inputs.jiraTicket }}](https://jira.mongodb.org/browse/${{ github.event.inputs.jiraTicket }})

.github/workflows/release-mongosh.yml

@@ -52,12 +52,10 @@ jobs:
           exit 1
         fi
 
-    - name: "Publish what is not already in NPM"
+    - name: "Trigger mongosh publish"
       env:
         NPM_TOKEN: ${{ secrets.DEVTOOLSBOT_NPM_TOKEN }}
         MONGOSH_RELEASE_PUBLISHER: ${{ github.triggering_actor }}
       run: |
         echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" >> ~/.npmrc
-        npm config list
-        echo "Publishing packages as $(npm whoami)"
         npm run publish

package-lock.json

@@ -38,7 +38,6 @@
     "compile-exec": "npm run evergreen-release compile",
     "compile-all": "npm run compile-compass && npm run compile-exec",
     "evergreen-release": "cd packages/build && npm run evergreen-release --",
-    "release": "cd packages/build && npm run release --",
     "report-missing-help": "npm run report-missing-help --workspace @mongosh/shell-api",
     "report-supported-api": "npm run report-supported-api --workspace @mongosh/shell-api",
     "post-process-nyc": "ts-node scripts/nyc/post-process-nyc-output.ts",

package.json

@@ -25,20 +25,11 @@ Execute the following steps to publish a new release:
 
 1. Ensure there is a Jira _Release_ ticket in the [`MONGOSH` project](https://jira.mongodb.org/projects/MONGOSH) for the new release and move it to _In Progress_.
 2. Verify that the Jira tickets you expect to be released are correctly mapped to the _Release_ ticket. Add any additional required documentation to the release ticket.
-3. Trigger the draft release by running:
-   ```
-   npm run release draft
-   ```
-   Follow the instructions and ensure that the new draft tag to be created matches the expected release version.
-4. Wait for Evergreen to finish the build and complete the draft stage.\
-   _Repeat step 3 if there are any additional changes that need to be part of the release._
+3. Trigger the draft release by triggering the `Prepare mongosh Release` workflow. Set the release Jira ticket and ensure that the new draft tag that gets created matches the expected release version.
+4. Wait for the workflow to create a PR for the release and ensure the changed files are correct. **Do not merge the PR!**
 5. Sync main branch of the [mongodb-js/homebrew-core](https://github.com/mongodb-js/homebrew-core/) repository with the upstream.
-6. Trigger the publication of the release by running:
-   ```
-   npm run release publish
-   ```
-   Follow the instructions and verify the inferred release version is correct.
-7. Wait for Evergreen to finish the publication stage.
+6. Trigger the `Release mongosh` workflow on the newly created `release/X.Y.Z` branch. This will start the release process and will automatically merge the PR once it is complete.
+7. Wait for Evergreen to finish the publication stage and automatically merge the PR.
 8. Close the Jira ticket for the release, post an update in the `#mongosh` Slack channel and ping the docs team.
 
 ### Branches and Tags

packages/build/README.md

@@ -24,7 +24,6 @@
     "check": "npm run lint && npm run depcheck",
     "depcheck": "depcheck",
     "evergreen-release": "ts-node -r ../../scripts/import-expansions.js src/index.ts",
-    "release": "ts-node src/index.ts trigger-release",
     "prettier": "prettier",
     "bump": "ts-node src/index.ts bump",
     "publish": "ts-node src/index.ts publish",

packages/build/package.json

@@ -2,14 +2,13 @@ import path from 'path';
 import { validatePackageVariant } from './config';
 import { downloadMongoDb } from '@mongodb-js/mongodb-downloader';
 import { getArtifactUrl } from './evergreen';
-import { triggerRelease } from './local';
 import type { ReleaseCommand } from './release';
 import { release } from './release';
 import type { Config, PackageVariant } from './config';
 
 export { getArtifactUrl, downloadMongoDb };
 
-const validCommands: (ReleaseCommand | 'trigger-release')[] = [
+const validCommands: ReleaseCommand[] = [
   'bump',
   'compile',
   'package',
@@ -19,12 +18,9 @@ const validCommands: (ReleaseCommand | 'trigger-release')[] = [
   'sign',
   'download-crypt-shared-library',
   'download-and-list-artifacts',
-  'trigger-release',
 ] as const;
 
-const isValidCommand = (
-  cmd: string
-): cmd is ReleaseCommand | 'trigger-release' =>
+const isValidCommand = (cmd: string): cmd is ReleaseCommand =>
   (validCommands as string[]).includes(cmd);
 
 if (require.main === module) {
@@ -38,31 +34,27 @@ if (require.main === module) {
       );
     }
 
-    if (command === 'trigger-release') {
-      await triggerRelease(process.argv.slice(3));
-    } else {
-      const config: Config = require(path.join(
-        __dirname,
-        '..',
-        '..',
-        '..',
-        'config',
-        'build.conf.js'
-      ));
+    const config: Config = require(path.join(
+      __dirname,
+      '..',
+      '..',
+      '..',
+      'config',
+      'build.conf.js'
+    ));
 
-      const cliBuildVariant = process.argv
-        .map((arg) => /^--build-variant=(.+)$/.exec(arg))
-        .filter(Boolean)[0];
-      if (cliBuildVariant) {
-        config.packageVariant = cliBuildVariant[1] as PackageVariant;
-        validatePackageVariant(config.packageVariant);
-      }
+    const cliBuildVariant = process.argv
+      .map((arg) => /^--build-variant=(.+)$/.exec(arg))
+      .filter(Boolean)[0];
+    if (cliBuildVariant) {
+      config.packageVariant = cliBuildVariant[1] as PackageVariant;
+      validatePackageVariant(config.packageVariant);
+    }
 
-      config.isDryRun ||= process.argv.includes('--dry-run');
-      config.useAuxiliaryPackagesOnly ||= process.argv.includes('--auxiliary');
+    config.isDryRun ||= process.argv.includes('--dry-run');
+    config.useAuxiliaryPackagesOnly ||= process.argv.includes('--auxiliary');
 
-      await release(command, config);
-    }
+    await release(command, config);
   })().then(
     () => process.exit(0),
     (err) =>