Skip to content

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

fix(cli): align generated Windows install guidance

jkomynofa0b8f7c1c6b
diff --git a/.github/workflows/build-cli-binaries.yml b/.github/workflows/build-cli-binaries.yml
index b2c74837e..c991f2a00 100644
--- a/.github/workflows/build-cli-binaries.yml
+++ b/.github/workflows/build-cli-binaries.yml
@@ -340,7 +340,8 @@ jobs:
- macOS x64 (Intel)
- macOS ARM64 (Apple Silicon)
- Windows support coming soon!
+ ❌ **Not Supported:**
+ - Windows — use [WSL](https://learn.microsoft.com/windows/wsl/install) and run the install script inside your WSL distribution
EOF
sed -i.bak "s|RELEASE_TAG_PLACEHOLDER|$RELEASE_TAG|g" INSTALL.md && rm -f INSTALL.md.bak
diff --git a/test/release-workflow.test.ts b/test/release-workflow.test.ts
index 022c15c9a..b023f5567 100644
--- a/test/release-workflow.test.ts
+++ b/test/release-workflow.test.ts
@@ -42,6 +42,7 @@ const changesetBinPath = new URL('../node_modules/.bin/changeset', import.meta.u
const releaseScriptUrl = new URL('../ts/scripts/changeset-release.sh', import.meta.url);
const releaseScriptPath = releaseScriptUrl.pathname;
const releaseScript = readFileSync(releaseScriptUrl, 'utf8');
+const rootInstallGuide = readFileSync(new URL('../INSTALL.md', import.meta.url), 'utf8');
const buildCliWorkflow = readFileSync(
new URL('../.github/workflows/build-cli-binaries.yml', import.meta.url),
'utf8'
@@ -418,6 +419,35 @@ if (!releaseScript.includes('New tag:[[:space:]]*@composio\\/cli@')) {
// --- build-cli-binaries.yml: the CLI binary workflow is the sole, hardened release writer ---
+const canonicalWindowsInstallGuidance = requireMatch(
+ rootInstallGuide,
+ /^(- Windows — .+)$/m,
+ 'canonical Windows install guidance'
+);
+const generatedInstallGuide = requireMatch(
+ buildCliWorkflow,
+ /cat > INSTALL\.md << 'EOF'\n([\s\S]*?)\n\s+EOF/,
+ 'generated CLI release INSTALL.md'
+);
+const generatedWindowsInstallGuidance = requireMatch(
+ generatedInstallGuide,
+ /^\s*(- Windows — .+)$/m,
+ 'generated Windows install guidance'
+);
+
+if (
+ !canonicalWindowsInstallGuidance.includes(
+ '[WSL](https://learn.microsoft.com/windows/wsl/install)'
+ )
+) {
+ throw new Error('INSTALL.md must direct Windows users to the canonical WSL instructions');
+}
+if (generatedWindowsInstallGuidance !== canonicalWindowsInstallGuidance) {
+ throw new Error(
+ 'build-cli-binaries.yml generated INSTALL.md must match the canonical Windows guidance'
+ );
+}
+
// A single failed platform must never publish a partial set: fail-fast: false makes the build
// job `success` only when every matrix leg passes, gating the release job.
if (!buildCliWorkflow.includes('fail-fast: false')) {