Merge remote-tracking branch 'origin/master' into 1.24-releases

Author: mcasimir

package-lock.json

@@ -260,7 +260,7 @@
     "@mongodb-js/compass-collection-stats": "^5.0.5",
     "@mongodb-js/compass-collections-ddl": "^3.0.5",
     "@mongodb-js/compass-connect": "^5.4.13",
-    "@mongodb-js/compass-crud": "^10.1.2",
+    "@mongodb-js/compass-crud": "^10.1.3",
     "@mongodb-js/compass-database": "^1.0.1",
     "@mongodb-js/compass-databases-ddl": "^3.0.5",
     "@mongodb-js/compass-deployment-awareness": "^10.0.7",
@@ -269,7 +269,7 @@
     "@mongodb-js/compass-field-store": "^6.0.3",
     "@mongodb-js/compass-find-in-page": "^2.0.4",
     "@mongodb-js/compass-home": "^4.2.0",
-    "@mongodb-js/compass-import-export": "^5.1.22",
+    "@mongodb-js/compass-import-export": "^5.2.2",
     "@mongodb-js/compass-indexes": "^3.0.10",
     "@mongodb-js/compass-instance": "^2.0.3",
     "@mongodb-js/compass-loading": "^1.0.7",
@@ -335,7 +335,7 @@
     "mongodb-ace-theme-query": "^0.0.2",
     "mongodb-collection-model": "^3.1.0",
     "mongodb-connection-model": "^17.0.3",
-    "mongodb-data-service": "^17.0.3",
+    "mongodb-data-service": "^17.0.4",
     "mongodb-database-model": "^0.1.3",
     "mongodb-explain-plan-model": "^0.2.3",
     "mongodb-extended-json": "^1.11.0",

package.json

@@ -3,6 +3,8 @@ const chalk = require('chalk');
 const _ = require('lodash');
 const git = require('./git');
 const ux = require('./ux');
+const version = require('./version');
+const semver = require('semver');
 
 function capitalize(s) {
   if (typeof s !== 'string') return '';
@@ -19,7 +21,23 @@ function renderCommit({ scope, message, pr, ticket }) {
   return `${scope ? `**${scope}**` + ': ' : ''}${capitalize(message)}${links}`;
 }
 
-async function render(previousTag, releaseTag) {
+async function render(releaseVersion) {
+  const releaseTag = `v${releaseVersion}`;
+  const isGaRelease = version.isGa(releaseTag);
+
+  const tags = await git.getTags();
+  if (!tags.includes(releaseTag)) {
+    throw new Error(`The release tag ${releaseTag} was not found. Is this release tagged?`);
+  }
+
+  // finds the first tag that is lower than releaseTag
+  const previousTag = tags
+    .filter((t) => t.startsWith('v') && semver.valid(t))
+    .filter((t) => isGaRelease ? version.isGa(t) : true) // if is GA only consider other GAs
+    .sort(semver.compare)
+    .reverse()
+    .find((t) => semver.lt(t, releaseTag));
+
   cli.info('');
   cli.info(`Changes from ${chalk.bold(previousTag)}:`);
 

release/changelog.js

@@ -2,7 +2,6 @@
 const { cli } = require('cli-ux');
 const chalk = require('chalk');
 const pkgUp = require('pkg-up');
-const semver = require('semver');
 
 const branch = require('./branch');
 const bump = require('./bump');
@@ -150,23 +149,7 @@ async function releaseCheckout(versionLike) {
 async function releaseChangelog() {
   await getValidReleaseBranch();
   const releaseVersion = await getPackageJsonVersion();
-  const tags = await git.getTags();
-  const releaseTag = `v${releaseVersion}`;
-  const isGaRelease = version.isGa(releaseTag);
-
-  if (!tags.includes(releaseTag)) {
-    throw new Error(`The release tag ${releaseTag} was not found. Is this release tagged?`);
-  }
-
-  // finds the first tag that is lower than releaseTag
-  const previousTag = tags
-    .filter((t) => t.startsWith('v') && semver.valid(t))
-    .filter((t) => isGaRelease ? version.isGa(t) : true) // if is GA only consider other GAs
-    .sort(semver.compare)
-    .reverse()
-    .find((t) => semver.lt(t, releaseTag));
-
-  await changelog.render(previousTag, releaseTag);
+  await changelog.render(releaseVersion);
 }
 
 async function releasePublish() {
@@ -197,7 +180,8 @@ async function releasePublish() {
 
   await publishRelease(releaseVersion, {
     downloadCenter: createDownloadCenter(),
-    github
+    github,
+    changelog
   });
 }
 

release/commands.js

@@ -1,15 +1,11 @@
 /* eslint-disable camelcase */
 const { Octokit } = require('@octokit/rest');
-const wait = require('./wait');
 
 const REPO = {
   owner: 'mongodb-js',
   repo: 'compass'
 };
 
-// NOTE: github has a rate limit for unauthenticated
-// request of 60 per hour:
-const WAIT_OPTIONS = { delay: 5 /* minutes */ * 60 * 1000 };
 
 async function getRelease(tagOrVersion) {
   const tag = tagOrVersion.startsWith('v') ? tagOrVersion : `v${tagOrVersion}`;
@@ -21,12 +17,12 @@ async function getRelease(tagOrVersion) {
   return releases.find(({ tag_name }) => tag_name === tag);
 }
 
-async function waitForReleasePublished(tagOrVersion) {
-  return await wait(
-    () => getRelease(tagOrVersion).then((release) => release && !release.draft),
-    WAIT_OPTIONS
-  );
+async function isReleasePublished(tagOrVersion) {
+  // NOTE: github has a rate limit for unauthenticated
+  // request of 60 per hour
+  const release = await getRelease(tagOrVersion);
+  return release && !release.draft;
 }
 
-module.exports = { waitForReleasePublished };
+module.exports = { isReleasePublished };
 

release/github.js

@@ -6,10 +6,10 @@ const version = require('./version');
 const ux = require('./ux');
 
 module.exports = async function publish(
-  releaseVersion, { downloadCenter, github }
+  releaseVersion, { downloadCenter, github, changelog }
 ) {
   await uploadConfigIfNewer(releaseVersion, { downloadCenter });
-  await waitGithubRelease(releaseVersion, { github });
+  await waitGithubRelease(releaseVersion, { github, changelog });
 
   cli.info(
     '\n',
@@ -40,19 +40,30 @@ async function uploadConfigIfNewer(
   cli.action.stop();
 }
 
-async function waitGithubRelease(releaseVersion, { github }) {
+async function waitGithubRelease(releaseVersion, { github, changelog }) {
+  cli.info('\n' + ux.separator(`👇 CHANGELOG FOR ${releaseVersion}`));
+  await changelog.render(releaseVersion);
+  cli.info('\n' + ux.separator('👆 CHANGELOG'), '\n');
+
   cli.info(
     '\n',
     ux.manualAction(
       'Make sure the release is published on Github: ',
       ux.link('https://github.com/mongodb-js/compass/releases'), '\n\n',
-      'You can run ', ux.command('npm run release changelog'), ' to get the release notes.', '\n\n',
+      'Copy the changelog from above and put it into the description of the release.', '\n\n',
       chalk.bold('NOTE:'), ' if a release is not published on Github the Compass auto-update will not pick that up.',
     ),
     '\n'
   );
 
-  cli.action.start(`Waiting for Github release ${chalk.bold(releaseVersion)} to be published.`);
-  await github.waitForReleasePublished(releaseVersion);
+  cli.info('Press enter when you have published the Github release...');
+  ux.waitForEnter();
+
+  cli.action.start(`Checking if Github release ${chalk.bold(releaseVersion)} really is published.`);
+  const alreadyPublished = await github.isReleasePublished(releaseVersion);
+  if (!alreadyPublished) {
+    cli.error('Release is not published yet - did you really publish?');
+    cli.info('Please publish the release on Github and run publish again to verify it worked.');
+  }
   cli.action.stop();
 }

release/publish.js

@@ -14,6 +14,8 @@ const publish = require('./publish');
 
 describe('publish', () => {
   let deps;
+  const isTty = process.stdin.isTTY;
+
   beforeEach(async() => {
     const downloadCenterConfig = await fs.readJSON(
       path.resolve(__dirname, 'fixtures', 'config.json')
@@ -25,15 +27,24 @@ describe('publish', () => {
     downloadCenter.uploadConfig = sinon.mock().resolves();
 
     const github = {
-      waitForReleasePublished: sinon.mock().resolves({
-        draft: true
-      })
+      isReleasePublished: sinon.mock().resolves(true)
+    };
+
+    const changelog = {
+      render: sinon.mock().resolves()
     };
 
     deps = {
       downloadCenter,
-      github
+      github,
+      changelog
     };
+
+    process.stdin.isTTY = false;
+  });
+
+  afterEach(() => {
+    process.stdin.isTTY = isTty;
   });
 
   it('skips upload if release version is same as download center', async() => {
@@ -54,16 +65,4 @@ describe('publish', () => {
     await (publish('1.23.0', deps));
     expect(deps.downloadCenter.uploadConfig).to.have.been.calledWith(expected);
   });
-
-  it('waits for a the github release to be published', async() => {
-    const error = await (publish('1.23.0', {
-      ...deps,
-      github: {
-        ...deps.github,
-        waitForReleasePublished: () => { throw new Error('maxWaitTime reached.'); }
-      }
-    })).catch(e => e);
-
-    expect(error.message).to.equal('maxWaitTime reached.');
-  });
 });

release/publish.spec.js

@@ -1,12 +1,16 @@
 const execa = require('execa');
 const chalk = require('chalk');
 
+function separator(message) {
+  return chalk.yellow(
+    chalk.bold(message)
+  );
+}
+
 function manualAction(...message) {
   return [
     '👉\t',
-    chalk.yellow(
-      chalk.bold('MANUAL ACTION REQUIRED!: ')
-    ),
+    separator('MANUAL ACTION REQUIRED!: '),
     '\n',
     ...message.join('').split('\n').map((m) => `\t${m}`).join('\n')
   ].join('');
@@ -29,6 +33,7 @@ function waitForEnter() {
 }
 
 module.exports = {
+  separator,
   manualAction,
   link,
   command,