chore(docs): add empty changeset step to actions (#6377)

- Creates a script that runs the `yarn changeset --empty` command if there are file changes. This is important to not create PRs of just empty changesets if there are no file changes.
- Run script in all docs-generation PRs
- Fix to condition in `generate-docblock` action

.changeset/great-pens-warn.md

@@ -0,0 +1,2 @@
+---
+---

.github/workflows/docs-new-announcement.yml

@@ -38,6 +38,10 @@ jobs:
         run: yarn generate:announcement
         working-directory: docs-util/packages/scripts
 
+      - name: Generate Changeset
+        run: "yarn generate:changeset"
+        working-directory: docs-util/packages/scripts
+
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v4
         with:

.github/workflows/docs-remove-announcement.yml

@@ -39,6 +39,10 @@ jobs:
         run: yarn generate:announcement --expire
         working-directory: docs-util/packages/scripts
 
+      - name: Generate Changeset
+        run: "yarn generate:changeset"
+        working-directory: docs-util/packages/scripts
+
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v4
         with:

.github/workflows/generate-docblocks-reference.yml

@@ -64,6 +64,10 @@ jobs:
         run: "yarn generate:reference all"
         working-directory: docs-util/packages/scripts
 
+      - name: Generate Changeset
+        run: "yarn generate:changeset"
+        working-directory: docs-util/packages/scripts
+
       - name: Get PR Message
         id: pr-message
         run: yarn generate:message

.github/workflows/generate-docblocks.yml

@@ -48,6 +48,11 @@ jobs:
           GIT_OWNER: ${{ github.repository_owner }}
           GIT_REPO: medusa
 
+      - name: Generate Changeset
+        if: steps.check-commit.outputs.is_release_commit == 'true'
+        run: "yarn generate:changeset"
+        working-directory: docs-util/packages/scripts
+
       - name: Create Pull Request
         if: steps.check-commit.outputs.is_release_commit == 'true'
         uses: peter-evans/create-pull-request@v5

.github/workflows/generate-references.yml

@@ -42,6 +42,14 @@ jobs:
       - name: Generate API Reference
         run: yarn openapi:generate
 
+      - name: Install and Build docs-util dependencies
+        run: yarn && yarn build
+        working-directory: docs-util
+
+      - name: Generate Changeset
+        run: "yarn generate:changeset"
+        working-directory: docs-util/packages/scripts
+
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v4
         with:
@@ -93,6 +101,10 @@ jobs:
         run: yarn generate:ui
         working-directory: docs-util/packages/react-docs-generator
 
+      - name: Generate Changeset
+        run: "yarn generate:changeset"
+        working-directory: docs-util/packages/scripts
+
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v4
         with:

docs-util/packages/scripts/package.json

@@ -12,7 +12,8 @@
     "merge:references": "yarn generate:reference merge",
     "check:freshness": "ts-node ./freshness-check.ts",
     "generate:message": "ts-node ./get-generate-diff-message.ts",
-    "check:release-commit": "node ./dist/check-release-commit.js"
+    "check:release-commit": "node ./dist/check-release-commit.js",
+    "generate:changeset": "node ./dist/run-changeset.js"
   },
   "version": "0.0.0",
   "type": "module",

docs-util/packages/scripts/run-changeset.ts

@@ -0,0 +1,26 @@
+import util from "node:util"
+import { exec } from "child_process"
+import path from "node:path"
+
+const promiseExec = util.promisify(exec)
+
+async function main() {
+  // check if there are any changes in diff
+  const diffFiles = (await promiseExec(`git diff --name-only`)).stdout
+    .toString()
+    .split("\n")
+    .filter(Boolean)
+
+  if (!diffFiles.length) {
+    console.log("No files were changed, skipping generating changeset...")
+    return
+  }
+
+  // run changeset
+  await promiseExec(`yarn changeset --empty`, {
+    cwd: path.resolve("..", "..", ".."),
+  })
+  console.log("Generated changeset.")
+}
+
+void main()