Migration for 1.103.0 and Windows docs (#21652)

mathieudutour · web-flow · commit c6766cfbfd9b · 2025-09-18T10:35:56.000+02:00
* Add migration for 1.103

* Workflows: Add default platforms when merging

* Update docs for windows
diff --git a/.github/workflows/changelog_enforcer.yml b/.github/workflows/changelog_enforcer.yml
@@ -14,19 +14,6 @@ jobs:
         id: enforce
         uses: raycast/github-actions/changelog-enforcer@master
         continue-on-error: true
-      - name: Prompt Claude for missing changelog
-        if: steps.enforce.outcome == 'failure'
-        uses: actions/github-script@v7
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          script: |
-            const body = "@claude Please add a CHANGELOG.md entry for this pull request.";
-            await github.rest.issues.createComment({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              issue_number: context.issue.number,
-              body,
-            });
       - name: Fail if changelog missing
         if: steps.enforce.outcome == 'failure'
         run: exit 1
diff --git a/.github/workflows/pull_request_merge.yml b/.github/workflows/pull_request_merge.yml
@@ -28,28 +28,73 @@ jobs:
       - name: Checkout PR
         run: gh pr checkout ${{ github.event.inputs.pr_number }}
       - name: Update CHANGELOG.md
+        id: update_changelog
         run: |
+          changelog_updated=false
+          updated_count=0
           changelogs=$(gh pr view ${{ github.event.inputs.pr_number }} --json files --jq '.files.[].path' | grep -i CHANGELOG.md || true)
           for changelog in $changelogs
           do
-              echo "$changelog:"
-              if [[ -f "$changelog" ]]; then
-                  pattern="{PR_MERGE_DATE}"
-                  replacement=$(date '+%Y-%m-%d')
-                  if grep -q $pattern $changelog; then
-                      echo "  pattern found"
-                      sed -i "" "s/$pattern/$replacement/g" $changelog
-                      # ubuntu: sed -i "s/$pattern/$replacement/g" $changelog
-                      echo "  updated to $replacement"
-                  else
-                      echo "  pattern not found - skipping"
-                  fi
+            echo "$changelog:"
+            if [[ -f "$changelog" ]]; then
+              pattern="{PR_MERGE_DATE}"
+              replacement=$(date '+%Y-%m-%d')
+              if grep -q $pattern $changelog; then
+                echo "  pattern found"
+                sed -i "" "s/$pattern/$replacement/g" $changelog
+                # ubuntu: sed -i "s/$pattern/$replacement/g" $changelog
+                echo "  updated to $replacement"
+                updated_count=$((updated_count+1))
               else
-                  echo "  skipping (file not existing)"
+                echo "  pattern not found - skipping"
               fi
+            else
+              echo "  skipping (file not existing)"
+            fi
           done
+          if [[ $updated_count -gt 0 ]]; then
+            changelog_updated=true
+          fi
+          echo "changelog_updated=$changelog_updated" >> $GITHUB_OUTPUT
+
+      - name: Add platforms field to package.json
+        id: add_platforms_field
+        run: |
+          platforms_added=false
+          modified_count=0
+          changed_extensions="${{ steps.get_changed_extensions.outputs.paths }}"
+          if [[ -n "$changed_extensions" ]]; then
+            echo "Changed extensions: $changed_extensions"
+            IFS=',' read -ra extension_paths <<< "$changed_extensions"
+            for extension_path in "${extension_paths[@]}"; do
+              package_json="$extension_path/package.json"
+              echo "Checking: $package_json"
+              if [[ -f "$package_json" ]]; then
+                # Check if platforms field exists
+                if ! jq -e '.platforms' "$package_json" > /dev/null 2>&1; then
+                  echo "  Adding platforms field to $package_json"
+                  # Add platforms field with ["macOS"] as default
+                  jq '. + {"platforms": ["macOS"]}' "$package_json" > "${package_json}.tmp" && mv "${package_json}.tmp" "$package_json"
+                  modified_count=$((modified_count+1))
+                else
+                  echo "  platforms field already exists in $package_json"
+                fi
+              else
+                echo "  package.json not found in $extension_path"
+              fi
+            done
+          else
+            echo "No changed extensions found"
+          fi
+          if [[ $modified_count -gt 0 ]]; then
+            platforms_added=true
+          fi
+          echo "platforms_added=$platforms_added" >> $GITHUB_OUTPUT
+
       - name: Optimise images
+        id: optimise_images
         run: |
+          images_optimized=false
           images=$(gh pr view ${{ github.event.inputs.pr_number }} --json files | jq -r '.files[].path | select(endswith("png") or endswith("jpeg") or endswith("jpg"))')
           images_array=()
           if [[ -n "$images" ]]; then
@@ -75,7 +120,9 @@ jobs:
                 imageoptim "${batch[@]}"
                 ((batch_number++))
             done
+            images_optimized=true
           fi
+          echo "images_optimized=$images_optimized" >> $GITHUB_OUTPUT
       - name: Commit changes
         id: commit_changes
         run: |
@@ -91,12 +138,39 @@ jobs:
             if [[ "$can_modify" == "false" ]]; then
               error="Edits from maintainers are disabled."
               echo $error
+              echo "error=$error" >> $GITHUB_OUTPUT
               exit 1
             fi
 
+            # Build a dynamic commit message based on previous steps
+            parts=()
+            if [[ "${{ steps.update_changelog.outputs.changelog_updated }}" == "true" ]]; then
+              parts+=("Update CHANGELOG.md")
+            fi
+            if [[ "${{ steps.add_platforms_field.outputs.platforms_added }}" == "true" ]]; then
+              parts+=("add platforms field")
+            fi
+            if [[ "${{ steps.optimise_images.outputs.images_optimized }}" == "true" ]]; then
+              parts+=("optimise images")
+            fi
+
+            # Join parts with commas and 'and' for the last item
+            if [[ ${#parts[@]} -eq 0 ]]; then
+              commit_msg="Automated maintenance updates"
+            else
+              commit_msg="${parts[0]}"
+              for (( i=1; i<${#parts[@]}; i++ )); do
+                if [[ $i -eq $((${#parts[@]}-1)) ]]; then
+                  commit_msg+=" and ${parts[$i]}"
+                else
+                  commit_msg+=", ${parts[$i]}"
+                fi
+              done
+            fi
+
             git add .
             git status .
-            git commit --message "Update CHANGELOG.md and optimise images"
+            git commit --message "$commit_msg"
 
             git push https://${{ env.GITHUB_TOKEN }}@github.com/$pr_repo_owner/$pr_repo_name.git HEAD:$pr_branch
             echo "Pushed changes."
diff --git a/docs/ai/getting-started.md b/docs/ai/getting-started.md
@@ -8,6 +8,9 @@ There are two ways to leverage the power of AI inside your extensions.
 
 {% hint style="info" %}
 To use AI APIs or AI Extensions, you need to subscribe to [Raycast Pro](https://raycast.com/pro).
+
+AI Extensions aren't available on Windows for now.
+
 {% endhint %}
 
 ## AI APIs
diff --git a/docs/api-reference/browser-extension.md b/docs/api-reference/browser-extension.md
@@ -8,6 +8,8 @@ Some users might not have installed the Browser Extension. If a user doesn't hav
 
 You can check if a user has the Browser Extension installed using [`environment.canAccess(BrowserExtension)`](./environment.md).
 
+The API is not accessible on Windows for now.
+
 {% endhint %}
 
 ## API Reference
diff --git a/docs/api-reference/menu-bar-commands.md b/docs/api-reference/menu-bar-commands.md
@@ -2,6 +2,12 @@
 
 The `MenuBarExtra` component can be used to create commands which populate the [extras](https://developer.apple.com/design/human-interface-guidelines/components/system-experiences/the-menu-bar#menu-bar-commands) section of macOS' menu bar.
 
+{% hint style="info" %}
+
+Menubar commands aren't available on Windows.
+
+{% endhint %}
+
 ## Getting Started
 
 If you don't have an extension yet, follow the [getting started](../basics/getting-started.md) guide and then return to this page.
diff --git a/docs/api-reference/window-management.md b/docs/api-reference/window-management.md
@@ -8,6 +8,8 @@ Some users might not have access to this API. If a user doesn't have access to R
 
 You can check if a user has access to the API using [`environment.canAccess(WindowManagement)`](./environment.md).
 
+The API is not accessible on Windows for now.
+
 {% endhint %}
 
 ## API Reference
diff --git a/docs/basics/contribute-to-an-extension.md b/docs/basics/contribute-to-an-extension.md
@@ -24,4 +24,4 @@ When you're done editing the extension, make sure to add yourself to the contrib
 
 Additionally, ensure the `CHANGELOG.md` file is updated with your changes; create it if it doesn't exist. Use the `{PR_MERGE_DATE}` placeholder for the date – see the [Version History documentation](prepare-an-extension-for-store.md#version-history) for details.
 
-Once everything is ready, see [how to publish an extension](publish-an-extension.md) for instructions on validating and publishing the changes (via a pull request).
+Once everything is ready, see [how to publish an extension](publish-an-extension.md) for instructions on validating and publishing the changes.
diff --git a/docs/basics/prepare-an-extension-for-store.md b/docs/basics/prepare-an-extension-for-store.md
@@ -12,6 +12,7 @@ Here you will find requirements and guidelines that you'll need to follow in ord
   - Ensure you use your **Raycast** account username in the `author` field
   - Ensure you use `MIT` in the `license` field
   - Ensure you are using the latest Raycast API version
+  - Ensure the `platforms` field matching the requirement of your extension, eg. if you use platform-specific APIs, restrict the `platforms` field to the corresponding platform
 - Please use `npm` for installing dependencies and include `package-lock.json` in your pull request. We use `npm` on our Continuous Integration (CI) environment when building and publishing extensions so, by providing a `package-lock.json` file, we ensure that the dependencies on the server match the same versions as your local dependencies.
 - Please check the terms of service of third-party services that your extension uses.
 - Read the [Extension Guidelines](https://manual.raycast.com/extensions) and make sure that your Extension comply with it.
diff --git a/docs/information/manifest.md b/docs/information/manifest.md
@@ -11,6 +11,7 @@ Here is a typical manifest file:
   "description": "My extension that can do a lot of things",
   "icon": "icon.png",
   "author": "thomas",
+  "platforms": ["macOS", "Windows"],
   "categories": ["Fun", "Communication"],
   "license": "MIT",
   "commands": [
@@ -35,10 +36,10 @@ All Raycast related properties for an extension.
 | description<mark style="color:red;">\*</mark> | The full description of the extension shown in the Store.                                                                                                                                                                                           |
 | icon<mark style="color:red;">\*</mark>        | A reference to an icon file in the assets folder. Use png format with a size of 512 x 512 pixels. To support light and dark theme, add two icons, one with `@dark` as suffix, e.g. `icon.png` and `icon@dark.png`.                                  |
 | author <mark style="color:red;">\*</mark>     | Your Raycast Store handle (username)                                                                                                                                                                                                                |
+| platforms <mark style="color:red;">\*</mark>  | An Array of platforms supported by the extension(`"macOS"` or `"Windows"`). If the extension uses some platform-specific APIs, restrict which platform can install it.                                                                              |
 | categories<mark style="color:red;">\*</mark>  | An array of categories that your extension belongs in.                                                                                                                                                                                              |
 | commands<mark style="color:red;">\*</mark>    | An array of [commands](./terminology.md#command) exposed by the extension, see [Command properties](manifest.md#command-properties).                                                                                                                |
 | tools                                         | An array of tools that the AI can use to interact with this extension, see [Tool properties](#tool-properties).                                                                                                                                     |
-| platforms                                     | An Array of platforms supported by the extension. If the extension uses some platform-specific APIs, add this field to restrict which platform can install it (`"macOS"` or `"Windows"`).                                                           |
 | ai                                            | Additional information related to the AI capabilities of the extension, see [AI properties](#ai-properties).                                                                                                                                        |
 | owner                                         | Used for extensions published under an organisation. When defined, the extension will be [private](../teams/getting-started.md) (except when specifying `access`).                                                                                  |
 | access                                        | Either `"public"` or `"private"`. Public extensions are downloadable by anybody, while [private](../teams/getting-started.md) extensions can only be downloaded by a member of a given organization.                                                |
@@ -78,7 +79,7 @@ All properties for extension or command-specific preferences. Use the [Preferenc
 | type<mark style="color:red;">\*</mark>        | The preference type. We currently support `"textfield"` and `"password"` (for secure entry), `"checkbox"`, `"dropdown"`, `"appPicker"`, `"file"`, and `"directory"`.                                                                                                                                                                                                                       |
 | required<mark style="color:red;">\*</mark>    | Indicates whether the value is required and must be entered by the user before the extension is usable.                                                                                                                                                                                                                                                                                    |
 | placeholder                                   | Text displayed in the preference's field when no value has been input.                                                                                                                                                                                                                                                                                                                     |
-| default                                       | The optional default value for the field. For textfields, this is a string value; for checkboxes a boolean; for dropdowns the value of an object in the data array; for appPickers an application name, bundle ID or path. Additionally, you can specify a different value per plaform by passing an object: <code>{ "macOS": ..., "Windows": ... }</code>`.                               |
+| default                                       | <p>The optional default value for the field. For textfields, this is a string value; for checkboxes a boolean; for dropdowns the value of an object in the data array; for appPickers an application name, bundle ID or path.</p><p>Additionally, you can specify a different value per plaform by passing an object: <code>{ "macOS": ..., "Windows": ... }</code>`.</p>                  |
 
 Depending on the `type` of the Preference, some additional properties can be required:
 
diff --git a/examples/api-examples/package.json b/examples/api-examples/package.json
@@ -6,6 +6,7 @@
   "icon": "command-icon.png",
   "license": "MIT",
   "author": "raycast",
+  "platforms": ["Windows", "macOS"],
   "commands": [
     {
       "name": "markdown",
diff --git a/examples/todo-list/package.json b/examples/todo-list/package.json
@@ -6,6 +6,7 @@
   "icon": "icon.png",
   "author": "thomas",
   "license": "MIT",
+  "platforms": ["Windows", "macOS"],
   "commands": [
     {
       "name": "index",
diff --git a/migrations/1.103.0/command.sh b/migrations/1.103.0/command.sh
@@ -0,0 +1 @@
+node -e "const fs = require('fs'); const path = './package.json'; if (!fs.existsSync(path)) { process.exit(0); } const pkg = JSON.parse(fs.readFileSync(path, 'utf8')); if (pkg.platforms === undefined) { pkg.platforms = ['macOS']; fs.writeFileSync(path, JSON.stringify(pkg, null, 2) + '\n'); }"
diff --git a/migrations/package-lock.json b/migrations/package-lock.json
diff --git a/migrations/package.json b/migrations/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@raycast/migration",
-  "version": "1.102.0",
+  "version": "1.103.0",
   "description": "Tool to automate the migration to a newer version of the @raycast/api",
   "main": "index.js",
   "bin": "./bin/migrate.js",

Original file line number	Diff line number	Diff line change
`@@ -24,4 +24,4 @@ When you're done editing the extension, make sure to add yourself to the contrib`
`24`	`24`
`25`	`25`	Additionally, ensure the `CHANGELOG.md` file is updated with your changes; create it if it doesn't exist. Use the `{PR_MERGE_DATE}` placeholder for the date – see the [Version History documentation](prepare-an-extension-for-store.md#version-history) for details.
`26`	`26`
`27`		`-Once everything is ready, see [how to publish an extension](publish-an-extension.md) for instructions on validating and publishing the changes (via a pull request).`
	`27`	`+Once everything is ready, see [how to publish an extension](publish-an-extension.md) for instructions on validating and publishing the changes.`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`	`"icon": "command-icon.png",`
`7`	`7`	`"license": "MIT",`
`8`	`8`	`"author": "raycast",`
	`9`	`+ "platforms": ["Windows", "macOS"],`
`9`	`10`	`"commands": [`
`10`	`11`	`{`
`11`	`12`	`"name": "markdown",`