Skip to content

docs: update Windows application testing notice to mirror upstream guidance - #1119

Merged
Dor-bl merged 2 commits into
appium:mainfrom
Dor-bl:docs/windows-driver-notice
Sep 22, 2026
Merged

Dor-bl merged 2 commits into
appium:mainfrom
Dor-bl:docs/windows-driver-notice

Conversation

@Dor-bl

@Dor-bl Dor-bl commented Sep 13, 2026

Copy link
Copy Markdown
Collaborator

Related issue

Closes # n/a

List of changes

  • Replaced the dated v5-specific WinAppDriver notice with a general Windows Application Testing section.
  • Clarified that Microsoft no longer maintains WinAppDriver and that standalone WAD does not support the W3C WebDriver protocol.
  • Pointed users to appium-windows-driver (appium driver install windows), which proxies to WinAppDriver over W3C.
  • Added a reference to NovaWindows Driver as recommended by upstream appium-windows-driver.
  • Updated the link to Windows integration tests to point directly to test/integration/Windows in the repository.

Types of changes

What types of changes are you proposing/introducing to the .NET client?
Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change that adds functionality or value)
  • Refactoring (non-breaking change that improves code without altering functionality)
  • Breaking change (fix or feature that would cause existing functionality not to work as expected)
  • New test coverage (non-breaking change that adds tests for existing, previously untested functionality)
  • Test fix (non-breaking change that improves test stability or correctness)
  • Chore/Maintenance (updates to build scripts, dependencies, or GitHub Actions)

Tests

Put an x in the boxes that apply

  • Unit tests
  • Integration tests
  • No automated tests (explain why below)

How they run: Documentation update only; no test or code modifications required.

Documentation

  • Have you proposed a file change/PR with Appium to update documentation?
  • Not applicable (no user-facing behaviour change, e.g. tests, CI or maintenance only)

Details

This update aligns the README with the current state of Windows automation across the Appium ecosystem. Standalone WinAppDriver has been abandoned by Microsoft and does not speak W3C. Upstream appium-windows-driver acts as a W3C bridge, and the community now also provides appium-novawindows-driver (using FlaUI). This notice gives clear guidance to developers automating Windows apps in .NET.

Copilot AI lite review requested due to automatic review settings September 13, 2026 14:41

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Correct the NovaWindows backend description and document the required Appium version.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

Updates the README with current Windows application testing guidance.

Changes:

  • Replaces the outdated WinAppDriver notice.
  • Documents appium-windows-driver and NovaWindows Driver.
  • Updates the Windows integration test link.
File summaries
File Summary
README.md Updates Windows automation documentation and links.
Review details

Suppressed comments (1)

README.md:105

  • The current appium-windows-driver package declares appium ^3.0.0-rc.2 as a peer dependency, while the surrounding README only documents upgrading the .NET client's server to Appium 2.x. On an Appium 2 installation this command will resolve an incompatible driver, so the Windows instructions need to state the Appium 3 prerequisite (or document an Appium 2-compatible driver version).
> - Use [appium-windows-driver](https://github.com/appium/appium-windows-driver) (`appium driver install windows`), which acts as a W3C-compliant proxy to WinAppDriver.
  • Files reviewed: 1/1 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread README.md
>
> To automate Windows applications:
> - Use [appium-windows-driver](https://github.com/appium/appium-windows-driver) (`appium driver install windows`), which acts as a W3C-compliant proxy to WinAppDriver.
> - Consider trying [NovaWindows Driver](https://github.com/AutomateThePlanet/appium-novawindows-driver) by [Automate The Planet](https://www.automatetheplanet.com/) as a modern drop-in replacement that operates directly via FlaUI / UI Automation without WinAppDriver.
Copilot AI review requested due to automatic review settings September 16, 2026 20:50

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

Documentation-only update with no unresolved review comments.

Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 0 new
  • Review effort level: Lite

@Dor-bl
Dor-bl merged commit 522f6b1 into appium:main Sep 22, 2026
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants