gemini-cli icon indicating copy to clipboard operation
gemini-cli copied to clipboard
Published 1 week ago • verified publisher icon google-gemini

Confidence: Define and document cross-platform support strategy

Open mattKorwel opened this issue 5 months ago • 2 comments

This task is to create a formal, user-facing document that clearly defines our cross-platform support strategy. This document will serve as the single source of truth for which operating systems and architectures we support and to what extent.

The Problem

As we expand our platform support, our users and contributors need to understand the level of testing and reliability they can expect for each environment. Without clear documentation, users may have a frustrating experience on a platform that is not fully supported, and contributors won't know which environments they need to consider when making changes.

The Goal

To create a new document (e.g., docs/xplat-support.md) that outlines our official support matrix. This document should clearly define:

  1. Supported Platforms: List the operating systems (macOS, Windows, Linux) and CPU architectures (amd64, arm64) that are officially supported.
  2. Levels of Support: Define the difference between "development" and "production" support. For example:
    • Production Support: Platforms that are fully validated with our entire test suite on every pull request.
    • Development Support: Platforms that are expected to work but may not have full, automated CI coverage.
  3. Testing Strategy: Briefly describe the automated testing that each supported platform receives (e.g., "Full e2e tests are run on windows-latest and macos-latest runners in CI").
  4. Known Limitations: Document any known issues, prerequisites (e.g., required versions of Docker), or workarounds for specific platforms.

Prerequisites

This documentation can only be written once the underlying technical work is complete. Therefore, this issue is blocked by the successful completion of the other tasks in this feature area:

  • #3717: Build and publish multi-platform Docker images
  • #3718: Add Windows to CI for build and test automation
  • #3720: Add Mac OS Ci Support

Once these are complete, we will have a clear picture of our capabilities to document for our users.

mattKorwel avatar Jul 10 '25 01:07 mattKorwel