fix(release): use draft releases to prevent binary race condition

.github/workflows/build-native-scanner.yml

@@ -321,6 +321,12 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
-      - run: yarn npm tag add `echo ${{ github.ref_name }} | sed -e s/-v/@/` latest
+      - name: Tag npm package as latest
+        run: yarn npm tag add `echo ${{ github.ref_name }} | sed -e s/-v/@/` latest
         env:
           YARN_NPM_AUTH_TOKEN: ${{ secrets.YARN_NPM_AUTH_TOKEN }}
+
+      - name: Publish draft release
+        run: gh release edit ${{ github.ref_name }} --draft=false
+        env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}

.github/workflows/build-native.yml

@@ -321,6 +321,12 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
-      - run: yarn npm tag add `echo ${{ github.ref_name }} | sed -e s/-v/@/` latest
+      - name: Tag npm package as latest
+        run: yarn npm tag add `echo ${{ github.ref_name }} | sed -e s/-v/@/` latest
         env:
           YARN_NPM_AUTH_TOKEN: ${{ secrets.YARN_NPM_AUTH_TOKEN }}
+
+      - name: Publish draft release
+        run: gh release edit ${{ github.ref_name }} --draft=false
+        env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}

.releaserc.js

@@ -1,7 +1,9 @@
 let commitMessage = 'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}';
 let publishArgs = '';
 const packageName = process.env.npm_package_name;
-if (packageName === '@appland/appmap' || packageName === '@appland/scanner') {
+const hasNativeBinaries = packageName === '@appland/appmap' || packageName === '@appland/scanner';
+
+if (hasNativeBinaries) {
   // Don't publish @appland/{appmap,scanner} as latest. This is done in a follow-up step.
   publishArgs = '--tag next';
 
@@ -10,64 +12,79 @@ if (packageName === '@appland/appmap' || packageName === '@appland/scanner') {
   commitMessage = commitMessage.replace(/\s\[skip ci\]/, '');
 }
 
+const plugins = [
+  [
+    '@semantic-release/commit-analyzer',
+    {
+      preset: 'angular',
+      releaseRules: [
+        {
+          type: 'feature',
+          release: 'minor',
+        },
+      ],
+    },
+  ],
+  '@semantic-release/release-notes-generator',
+  '@semantic-release/changelog',
+  [
+    '@google/semantic-release-replace-plugin',
+    {
+      replacements: [
+        {
+          files: ['package.json'],
+          from: /(?<="version":\s*").*(?=")/,
+          to: '${nextRelease.version}',
+          countMatches: true,
+          results: [
+            {
+              file: 'package.json',
+              hasChanged: true,
+              numMatches: 1,
+              numReplacements: 1,
+            },
+          ],
+        },
+      ],
+    },
+  ],
+  [
+    '@semantic-release/exec',
+    {
+      publishCmd: 'yarn build',
+    },
+  ],
+  [
+    '@semantic-release/git',
+    {
+      message: commitMessage,
+    },
+  ],
+];
+
+// Only create GitHub releases for packages with native binaries.
+// Other packages only need git tags, which are created automatically.
+if (hasNativeBinaries) {
+  // Create draft releases to avoid race condition where clients see the release before binaries are attached.
+  // The build-native workflows will publish the draft after all binaries are uploaded.
+  plugins.push([
+    '@semantic-release/github',
+    {
+      draftRelease: true,
+    },
+  ]);
+}
+
+plugins.push([
+  '@semantic-release/exec',
+  {
+    verifyConditionsCmd: 'test -n "$YARN_NPM_AUTH_TOKEN"',
+    publishCmd: `yarn npm publish ${publishArgs}`,
+  },
+]);
+
 module.exports = {
   branches: ['main'],
-  plugins: [
-    [
-      '@semantic-release/commit-analyzer',
-      {
-        preset: 'angular',
-        releaseRules: [
-          {
-            type: 'feature',
-            release: 'minor',
-          },
-        ],
-      },
-    ],
-    '@semantic-release/release-notes-generator',
-    '@semantic-release/changelog',
-    [
-      '@google/semantic-release-replace-plugin',
-      {
-        replacements: [
-          {
-            files: ['package.json'],
-            from: /(?<="version":\s*").*(?=")/,
-            to: '${nextRelease.version}',
-            countMatches: true,
-            results: [
-              {
-                file: 'package.json',
-                hasChanged: true,
-                numMatches: 1,
-                numReplacements: 1,
-              },
-            ],
-          },
-        ],
-      },
-    ],
-    [
-      '@semantic-release/exec',
-      {
-        publishCmd: 'yarn build',
-      },
-    ],
-    [
-      '@semantic-release/git',
-      {
-        message: commitMessage,
-      },
-    ],
-    '@semantic-release/github',
-    [
-      '@semantic-release/exec',
-      {
-        verifyConditionsCmd: 'test -n "$YARN_NPM_AUTH_TOKEN"',
-        publishCmd: `yarn npm publish ${publishArgs}`,
-      },
-    ],
-  ],
+  plugins,
   extends: 'semantic-release-monorepo',
 };