chore(NODE-5328): add dry-run nightly release automation (mongodb#3698)

Co-authored-by: Bailey Pearson <[email protected]>

Author: nbbeeken

.github/scripts/nightly.mjs

@@ -0,0 +1,71 @@
+// @ts-check
+import * as url from 'node:url';
+import * as fs from 'node:fs/promises';
+import * as path from 'node:path';
+import * as process from 'node:process';
+import * as child_process from 'node:child_process';
+import * as util from 'node:util';
+const exec = util.promisify(child_process.exec);
+
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url));
+const pkgFilePath = path.join(__dirname, '..', '..', 'package.json');
+
+process.env.TZ = 'Etc/UTC';
+
+/**
+ * FORMAT : M.M.P-dev+YYYYMMDD.sha.##########
+ * EXAMPLE: 5.6.0-dev+20230601.sha.0853c6957c
+ */
+class NightlyVersion {
+  /** @param {string} version */
+  constructor(version) {
+    /** @type {string} */
+    this.version = version;
+    const [, meta] = this.version.split('+');
+    const [dateString, commit] = meta.split('.sha.');
+    /** @type {string} */
+    this.commit = commit;
+    /** @type {string} */
+    this.dateString = dateString;
+  }
+  static async currentNightlyVersion() {
+    const { stdout } = await exec('npm show --json mongodb', { encoding: 'utf8' });
+    /** @type {{'dist-tags': {nightly?: string} }} */
+    const showInfo = JSON.parse(stdout);
+    const version = showInfo?.['dist-tags']?.nightly ?? '0.0.0-dev+YYYYMMDD.sha.##########';
+    return new NightlyVersion(version);
+  }
+  static async currentCommit() {
+    const { stdout } = await exec('git rev-parse --short HEAD', { encoding: 'utf8' });
+    return stdout.trim();
+  }
+  static async generateNightlyVersion() {
+    console.log('Generating new nightly version');
+    const currentCommit = await NightlyVersion.currentCommit();
+    const today = new Date();
+    const year = `${today.getFullYear()}`;
+    const month = `${today.getMonth()}`.padStart(2, '0');
+    const day = `${today.getUTCDate()}`.padStart(2, '0');
+    const yyyymmdd = `${year}${month}${day}`;
+
+    const pkg = JSON.parse(await fs.readFile(pkgFilePath, { encoding: 'utf8' }));
+
+    console.log('package.json version is:', pkg.version);
+    pkg.version = `${pkg.version}-dev+${yyyymmdd}.sha.${currentCommit}`;
+    console.log('package.json version updated to:', pkg.version);
+
+    await fs.writeFile(pkgFilePath, JSON.stringify(pkg, undefined, 2), { encoding: 'utf8' });
+  }
+}
+
+const currentPublishedNightly = await NightlyVersion.currentNightlyVersion();
+console.log('current published nightly:', currentPublishedNightly?.version);
+const currentCommit = await NightlyVersion.currentCommit();
+console.log('current commit sha:', currentCommit);
+
+if (currentPublishedNightly.commit === currentCommit) {
+  console.log('Published nightly is up to date');
+  process.exit(1);
+}
+await NightlyVersion.generateNightlyVersion();
+process.exit(0);

.github/workflows/release-nightly.yml

@@ -0,0 +1,30 @@
+on:
+  schedule:
+    # Timezone is UTC
+    # https://crontab.guru/#0_20_*_*_1-5
+    # At 20:00 on every day-of-week from Monday through Friday.
+    - cron: '0 20 * * 1-5'
+
+name: release-nightly
+
+jobs:
+  release-nightly:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: main
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 'lts/*'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm install -g npm
+      - run: npm clean-install
+      - run: npm run build:nightly
+        continue-on-error: true
+      - if: ${{ success() }}
+        run: npm publish --dry-run --provenance --tag=nightly
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -283,6 +283,18 @@ try {
 }
 ```
 
+## Nightly releases
+
+If you need to test with a change from the latest `main` branch our `mongodb` npm package has nightly versions released under the `nightly` tag.
+
+```sh
+npm install mongodb@nightly
+```
+
+Nightly versions are published regardless of testing outcome.
+This means there could be sematic breakages or partially implemented features.
+The nightly build is not suitable for production use.
+
 ## Next Steps
 
 - [MongoDB Documentation](https://www.mongodb.com/docs/manual/)

package.json

@@ -110,6 +110,7 @@
     "build:dts": "npm run build:ts && api-extractor run && node etc/clean_definition_files.cjs",
     "build:docs": "./etc/docs/build.ts",
     "build:typedoc": "typedoc",
+    "build:nightly": "node ./.github/scripts/nightly.mjs",
     "check:bench": "node test/benchmarks/driverBench",
     "check:coverage": "nyc npm run test:all",
     "check:integration-coverage": "nyc npm run check:test",